參考文檔
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升級插件不可用： http://www.tuicool.com/articles/Ybamaa
- 生成docset
對于最新版本的appledoc來說，它默認(rèn)時是生成docset文檔并集成到xcode愿卸。在終端中使用cd命令進(jìn)入項目的文件夾，然后執(zhí)行下列命令:
appledoc --output ./doc --project-name objcdoc --project-company "abc" --company-id "cn.com.abc" .
output ./doc：設(shè)置輸出目錄為“./doc”必盖。
--project-name objcdoc：設(shè)置項目名為“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)前項目文件夾下執(zhí)行婚瓜，如果想改變生成目錄，就用絕對目錄：cd – 這個命令刑棵，可以查看絕對路徑巴刻。
設(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這個目錄的讀寫權(quán)限蛉签。
- 可以生成指定目錄下的代碼的注釋嘴脾，方法是：在指定目錄下執(zhí)行appledoc命令恤批。
- 嚴(yán)格按照要求進(jìn)行注釋，格式一定要對齊，如：
/**
* @brief -100~100,負(fù)值表示自右向左纸兔，正值表示自左向右定躏。
* @warning zhuyi.
*/
- 生成類別：
///-------------------------------------------------
/// @name Project values handling
///-------------------------------------------------
zhushi.png
安裝 VVDocumenter 快捷注釋合武，自定義快捷鍵, 這個沒坑跃脊，自行探索。
