使用Objective-C的文档生成工具:appledoc

一、appledoc工具介绍

类似于Java 自带的 javadoc可以用于自动生成代码文档。仅用于oc项目，swift生成可用jazzy参见五、参考文献 3

二、appledoc工具安装

• 打开终端输入以下命令，默认安装在用户名文件下

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

三、appledoc工具使用

方式1：生成docset-installed.txt然后查找文档

• 先cd到你的项目目录下（若使用cocopods，需要定位到二级项目名下）
  • ./doc即输出文件路径
  • ./即生成文档遍历的文件夹路径
• 在终端输入以下语句

appledoc -o ./doc --project-name 填工程名 --project-company 填公司名 ./

• 此步骤执行完成后会在项目文件夹下生成一个docset-installed.txt，打开docset-installed.txt可看到生成文档路径，cmd+shift+G 定位到该文件路径上层文件夹DocSets下，找到com.liuna.test.test.docset，右键显示包内容找到index.html即可。

index.html
包内容

方式2：生成docset-installed.txt然后查找文档

• cd到项目文件夹下（若使用cocopods，需要定位到二级项目名下）
• 终端输入

appledoc --no-create-docset --output ./doc  --project-name 输入项目名 --project-company 输入公司名 ./

• 执行后在项目名文件夹下生成一个doc的文件夹，找到index.html即生成的项目文档

index.html

四、appledoc生成文档注释规定的格式

• 详细参见：五、参考文献 2

/// 单行注释

/** 单行注释 */

/** 注释
 * 多行注释
 */

/** 注释
 多行注释
 */

/*! 单行注释 */

/*! 注释
 over multiple lines.
 */

五、参考文献

• 1. 唐巧：使用Objective-C的文档生成工具:appledoc
• 2. Objective-C规范注释心得——同时兼容appledoc（docset、html）与doxygen（html、pdf）的文档生成
• 3. swift文档生成工具jazzy