參考文檔
appledoc：http://www.cnblogs.com/zyl910/archive/2013/06/07/objcdoc.html
Alcatraz：http://www.tuicool.com/articles/Vffumym
Alcatraz 安裝之后可以用它安裝VVDocumenter，參考地址：https://github.com/onevcat/VVDocumenter-Xcode
解決xcode升級(jí)插件不可用： http://www.tuicool.com/articles/Ybamaa
- 生成docset
對(duì)于最新版本的appledoc來說，它默認(rèn)時(shí)是生成docset文檔并集成到xcode。在終端中使用cd命令進(jìn)入項(xiàng)目的文件夾，然后執(zhí)行下列命令:
appledoc --output ./doc --project-name objcdoc --project-company "abc" --company-id "cn.com.abc" .
output ./doc：設(shè)置輸出目錄為“./doc”。
--project-name objcdoc：設(shè)置項(xiàng)目名為“objcdoc”。
--project-company "abc"：設(shè)置公司名為“abc”。
--company-id "cn.com.abc"：設(shè)置公司id為“cn.com.abc”。
. ：表示當(dāng)前目錄。
如果要生成html格式：
appledoc --no-create-docset --output ./doc --project-name objcdoc --project-company "abc" --company-id "cn.com.abc" .
但是這些都是在當(dāng)前項(xiàng)目文件夾下執(zhí)行，如果想改變生成目錄，就用絕對(duì)目錄：cd – 這個(gè)命令，可以查看絕對(duì)路徑。
設(shè)置生成注釋文檔在桌面的temp文件夾下：
appledoc --no-create-docset --output /users/yourUserName/Desktop/temp/doc/projectName --project-name projectName --project-company “abc” --company-id “com.abc” .
appledoc :
- 安裝appledoc之后，在usr/local/bin 你要有bin這個(gè)目錄的讀寫權(quán)限。
- 可以生成指定目錄下的代碼的注釋，方法是：在指定目錄下執(zhí)行appledoc命令。
- 嚴(yán)格按照要求進(jìn)行注釋，格式一定要對(duì)齊，如：
/**
* @brief -100~100,負(fù)值表示自右向左，正值表示自左向右。
* @warning zhuyi.
*/
- 生成類別：
///-------------------------------------------------
/// @name Project values handling
///-------------------------------------------------
zhushi.png
安裝 VVDocumenter 快捷注釋，自定義快捷鍵, 這個(gè)沒坑，自行探索。
