2019-07-18 AppleDoc生成文档

git clone git://github.com/tomaz/appledoc.git
cd ./appledoc
sudo sh install-appledoc.sh

![Pasted Graphic.png](https://upload-images.jianshu.io/upload_images/3739252-365444af9aa2bbc8.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240)

![image.png](https://upload-images.jianshu.io/upload_images/3739252-3907efd2e5a26ee3.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240)

# Type a script or drag a script file from your workspace to insert its path.
#appledoc Xcode script
# Start constants
company="XXX";
companyID="com.XXX";
companyURL="XXX";
target="os";
#target="macosx";
outputPath="./doc";
# End constants
/usr/local/bin/appledoc \
--project-name "${PROJECT_NAME}" \
--project-company "${company}" \
--company-id "${companyID}" \
--docset-atom-filename "${company}.atom" \
--docset-feed-url "${companyURL}/${company}/%DOCSETATOMFILENAME" \
--docset-package-url "${companyURL}/${company}/%DOCSETPACKAGEFILENAME" \
--docset-fallback-url "${companyURL}/${company}" \
--output "${outputPath}" \
--publish-docset \
--docset-platform-family "${target}" \
--ignore "Pods" \
--keep-intermediate-files \
--no-repeat-first-par \
--no-warn-invalid-crossref \
--create-html \
--no-create-docset \
--no-install-docset \
--no-publish-docset \
--exit-threshold 2 \
"${PROJECT_DIR}"

注释规范:
1. /*!  this a test . */
2. /**  this a comment. */
3. /// this is a long comment. */

经常使用的标签
@brief : 使用它来写一段你正在文档化的method, PRoperty, class, file, struct, 或enum的短描述信息。
@discusstion: 用它来写一段详尽的描述。如果需要你可以添加换行。
@param:通过它你可以描述一个 method 或 function的参数信息。你可以使用多个这种标签。
@return: 用它来制定一个 method 或 function的返回值。
@see: 用它来指明其他相关的 method 或 function。你可以使用多个这种标签。
@sa:同上
@code ： 使用这个标签，你可以在文档当中嵌入代码段。当在Help Inspector当中查看文档时，代码通过在一个特别的盒子中用一种不同的字体来展示。始终记住在写的代码结尾处使用@endcode标签。
@remark : 在写文档时，用它来强调任何关于代码的特殊之处。