使用 appledoc 生成 Objective-C 开发文档

在公司日常的编码工作中，很多时候开发者很抗拒写开发文档，因为业务已经通过代码进行了实现，如果再次需要编写对应的文档，可能还需要花费比编码更长的时间才能完成。但开发文档在公司内部，尤其是员工间工作沟通，或者新员工熟悉项目时却很有必要。

Java 有甲骨文公司开发的 Javadoc 源码文档生成工具。作为 iOS 开发者，如果你公司的项目还在使用 Objective-C 编写 iOS 程序，可以使用 appledoc 自动生成开发文档，生成的文档格式和 Apple 官方一致，还是比较方便的。

appledoc 的项目地址是 https://github.com/tomaz/appledoc，安装也比较简单，执行代码如下：

// 克隆项目源码
git clone https://github.com/tomaz/appledoc
// 进入项目目录
cd ./appledoc
// 执行安装脚本
sudo sh install-appledoc.sh

稍等片刻以后，可以使用以下代码验证安装是否成功

// 查看版本，如果显示版本，则证明安装成功
appledoc --version
// 查看 appledoc 的帮助命令
appledoc --help

安装成功后，进入至项目目录下，如你的项目名为 projectname

cd projectname

进入项目目录下执行以下命令，其中 output 为文档输出路径，示例代码输出路径为该项目目录下的 doc 文件夹内；project-name 为工程名；company-id 为公司 ID，可以使用 bundle id；project-company 公司名称。

注意：在公司名后有一个空白符并以 . 结束。

appledoc --no-create-docset --output="./doc" --project-name="开眼App名称" --company-id="bundle id" --project-company="开眼公司" .

以示例的代码生成文档，生成完成后在项目目录下多了一个名字为 doc 的文件夹，文件夹内包含了该文档的 HTML 源文件，通过浏览器打开如下图所示：

如图所示，该文档完整了展示了项目中的类、协议、扩展等方法。点击单个类名称则进入这个类的详情页面，展示这个类中所有的方法以及方法的使用，如果该方法很好的进行了备注，则可以很直观的看到该方法对应的释义。

做到这一步，剩下的就是完善编程规范了，如果编码时类名称、方法名称命名合理，耦合度适宜，并且方法的备注得当，阅读这份文档就可以很好的熟悉项目，了解业务代码的具体实现了。