- HeaderDoc
这是一款Xcode自带的工具,注释要有严格的标准,
比如我创建了一个工程,名字就叫TestDoc,然后再创建一个Target
1.选中你的工程,点击Add Target按钮,选择 Other -> Aggregate模板新建.
2.点击Add Build Phase按钮,添加一个Run Script.
编写以下脚本,跑一遍,当然在这之前,你的注释文档应该是有格式化的
mkdir -p headerDoc
find ./TestDoc -name *.h -print | xargs headerdoc2html -o headerDoc
gatherheaderdoc headerDoc
exit 0
- appledoc
如果想要集成进Xcode工程:
1.选中你的工程,点击Add Target按钮,选择 Other -> Aggregate模板新建.
2.点击Add Build Phase按钮,添加一个Run Script.
3.把下面的模板代码复制进去,把前几行参数改成你自己的.
4.在Xcode左上角选择这个新建的Target,然后点击build.
5.文档就会编译好并且自动安装进Xcode了(重启Xcode生效).
#appledoc Xcode script
# Start constants
company="ACME";
companyID="com.ACME";
companyURL="http://ACME.com";
target="iphoneos";
#target="macosx";
outputPath="~/help";
# 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}" \
--logformat xcode \
--keep-intermediate-files \
--no-repeat-first-par \
--no-warn-invalid-crossref \
--exit-threshold 2 \
"${PROJECT_DIR}”
- 凡是以 "///"、"/*"或"/!"开头的注释块，都算所appledoc注释。
- 在注释块内，appledoc支持如下语法：Markdown、HTML、HeaderDoc Tags。
/**
@brief
这里是方法的简介。该Tag不能放到类注释里。
@exception
UIColorException 这里是方法抛出异常的说明
@see
YYColor
@see
someMethod:
@warning
这里是警告，会显示成蓝色的框框
@bug
这里是bug，会显示成黄色的框框
@param
red 这里是参数说明1
@param
green 这里是参数说明2
@param
blue 这里是参数说明3
@return 这里是返回值说明
*/
