Appledoc - Source Documents

Link : GitHub，官网

从源码中抽取出文档的工具！

特点

• 默认生成的文档风格和苹果的官方文档一致。
• Appledoc 使用 Objective-C 编写，可以对源代码进行调试和改动。
• 生成 docset，并且集成到 Xcode 中。按住 Option 并点击相应 API 可以直接调出帮助文档。

安装步骤

• 使用终端命令进行安装（下载速度比较慢，建议去 Github 上下载）

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

• 进入工程项目根目录中

 cd projectPath

• 执行 appledoc 命令

appledoc --project-name projectname 
         --project-company companyname 
         --company-id com.companyname #可选
         --output pathWithDocsetPathText #可选，docset-installed.txt，文本里面含有 docset 的路径，默认路径是 ~/Library/Developer/Shared/Documentation/DocSets 
         inputFilePath #必要，导入到文档中的所在文件路径，使用 . 默认是当前路径

其他命令：appledoc --version 查看版本，appledoc --help 帮助命令。
若不想生成 docset ，在 appledoc 后面加 --no-create-docset。

• 执行完成后前往 docset 路径右键打开 companyid.projectname.docset 显示包内容，Contents -> Resources -> Documents 打开 index.html 便可查看文档内容。
• 重启 Xcode 也能在 Help -> Documentation and API Reference下看到生成的文档。

将运行脚本集成到工程中

• 在工程中新建 New -> File -> Target
• 新建 Other -> Aggretage 命名 Documents
• 进入该 target 的设置界面 Build Phases -> 点击添加按钮 -> 添加 Run Script
• 设置脚本为上面 appledoc 命令，需要额外添加 --exit-threshold 2 参数，不然运行时会报以下报错：

Command /bin/sh failed with exit code 1

完成上述设置之后，以后需要更新文档，直接运行 aggretage 即可。

源代码

代码需要添加一定格式的注释才能在文档中显示，使用 CMD + Option + / 添加注释即可满足需求。