用appledoc生成文档

发表于   |   分类于   |  

安装

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

检验是否安装成功

1
2
➜  ~ appledoc --version
appledoc version: 2.2.1 (build 1333)

使用

进入工程目录运行下面的命令

1
2
3
appledoc --project-name XXX --project-company "XXX" --company-id XXX --output /tmp/doc ./
➜  ~  cd Documents/iOS/Github/PTKit 
➜  PTKit git:(master) appledoc --project-name PTKit --project-company com.paitao --output ./PTKitDoc ./

其中，XXX 的内容根据具体情况填写，—output 后面接的是文档输出路径，最后一个路径，是需要生成文档的源代码所在路径。
icon

这时候你打开Xcode中Documentation就可以看到自己生成的Docset了

icon

语法

appledoc需要生成合格的文档需要文档中的注释规范化才能被appledoc认可。
凡是以 “///“、”/*”或”/!”开头的注释块，都算所appledoc注释。下面是示例:

1
2
3
4
5
6
/// 这是单行注释。
/** 这也是单行注释 */
/*! 同样是单行注释 *
/** 这也是单行注释，
 *  第二行会接上第一行。
 */

注释块中，每一行开头的空格和”*”字符多数情况都会被appledoc忽略。
连续的两行(即没有间隔空行)的注释，将被合并成一个段落，并忽略换行，就像html。
在注释中起初我也遇到了问题，使用了下面这种格式，appledoc就无法识别了

1
/* 同样是单行注释 */

icon
icon

在注释块内，appledoc支持Markdown、HTML等语法。