文档生成工具 appledoc

参考文章

1、安装：

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

2、注释添加规则：

1）多行注释 
/** 
　　多行注释  (/* 不会被捉取 */)
*/

2) 单行注释
//// 单行注释  
// 不会被捉取

3) 
　　@brief 简要说明
　　@param 参数说明 @param name description
　　@return 返回值说明
　　@exception 描述 exception

4）对于同一个方法不能出现两个或两个以上地方的文档注释，否则.h文件里的注释会覆盖了.m文件

3、使用

$ appledoc --project-name TestDoc --project-company "xxxxx-inc" --company-id com.xxxxx-inc.TestDoc .

　　注意：

　　　　a) 该命令只扫描当前目录下的所有文件。

　　　　b) 生成 .docSet 文件于 "/Users/xxx/Library/Developer/Shared/Documentation/DocSets/com.eileen.testdoc.testDoc.docset"

4、帮助

$ appledoc --help