appledoc:Objective-C注释文档生成工具

时间:2022-04-20 05:03:12

appledoc是帮助Objective-C开发者从特殊格式的源代码注释中生成类似apple资源代码帮助文档的命令行工具。

安装和使用都非常简单:

安装

git clone git://github.com/tomaz/appledoc.git 
cd appledoc 
sudo sh install-appledoc.sh

使用

在终端中使用cd命令进入项目的文件夹,然后执行下列命令:

appledoc --output ./doc --project-name SD4iPhone --project-company "sammydress" --company-id "com.zyl910" .

output ./doc:设置输出目录为“./doc”。
       project-name objcdoc:设置项目名为"SD4iPhone"。--project-company "sammydress":设置公司名为“sammydress”。
       company-id "com.sammydress":设置公司id为“com.sammydress”。
       .:当前目录。

参考:http://www.cnblogs.com/zyl910/archive/2013/06/07/objcdoc.html