参考文档
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来说,它默认时是生成docset文档并集成到xcode。在终端中使用cd命令进入项目的文件夹,然后执行下列命令:
appledoc --output ./doc --project-name objcdoc --project-company "abc" --company-id "cn.com.abc" .
output ./doc:设置输出目录为“./doc”。
--project-name objcdoc:设置项目名为“objcdoc”。
--project-company "abc":设置公司名为“abc”。
--company-id "cn.com.abc":设置公司id为“cn.com.abc”。
. :表示当前目录。
如果要生成html格式:
appledoc --no-create-docset --output ./doc --project-name objcdoc --project-company "abc" --company-id "cn.com.abc" .
但是这些都是在当前项目文件夹下执行,如果想改变生成目录,就用绝对目录:cd – 这个命令,可以查看绝对路径。
设置生成注释文档在桌面的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这个目录的读写权限。
- 可以生成指定目录下的代码的注释,方法是:在指定目录下执行appledoc命令。
- 严格按照要求进行注释,格式一定要对齐,如:
/**
* @brief -100~100,负值表示自右向左,正值表示自左向右。
* @warning zhuyi.
*/
- 生成类别:
///-------------------------------------------------
/// @name Project values handling
///-------------------------------------------------
安装 VVDocumenter 快捷注释,自定义快捷键, 这个没坑,自行探索。