一跷跪、appledoc工具介紹
類似于Java 自帶的 javadoc可以用于自動(dòng)生成代碼文檔锻狗。僅用于oc項(xiàng)目祟同，swift生成可用jazzy參見五楷掉、參考文獻(xiàn) 3
二厢蒜、appledoc工具安裝
- 打開終端輸入以下命令，默認(rèn)安裝在用戶名文件下
git clone git://github.com/tomaz/appledoc.git
cd appledoc
sudo sh install-appledoc.sh
三烹植、appledoc工具使用
方式1：生成docset-installed.txt然后查找文檔
- 先cd到你的項(xiàng)目目錄下（若使用cocopods斑鸦，需要定位到二級(jí)項(xiàng)目名下）
- ./doc即輸出文件路徑
- ./即生成文檔遍歷的文件夾路徑
- 在終端輸入以下語句
appledoc -o ./doc --project-name 填工程名 --project-company 填公司名 ./
- 此步驟執(zhí)行完成后會(huì)在項(xiàng)目文件夾下生成一個(gè)docset-installed.txt，打開docset-installed.txt可看到生成文檔路徑草雕，cmd+shift+G 定位到該文件路徑上層文件夾DocSets下巷屿，找到com.liuna.test.test.docset，右鍵顯示包內(nèi)容找到index.html即可墩虹。
index.html
包內(nèi)容
方式2：生成docset-installed.txt然后查找文檔
- cd到項(xiàng)目文件夾下（若使用cocopods嘱巾，需要定位到二級(jí)項(xiàng)目名下）
- 終端輸入
appledoc --no-create-docset --output ./doc --project-name 輸入項(xiàng)目名 --project-company 輸入公司名 ./
- 執(zhí)行后在項(xiàng)目名文件夾下生成一個(gè)doc的文件夾，找到index.html即生成的項(xiàng)目文檔
index.html
四诫钓、appledoc生成文檔注釋規(guī)定的格式
- 詳細(xì)參見：五旬昭、參考文獻(xiàn) 2
/// 單行注釋
/** 單行注釋 */
/** 注釋
* 多行注釋
*/
/** 注釋
多行注釋
*/
/*! 單行注釋 */
/*! 注釋
over multiple lines.
*/
