iOS生成代码注释文档

Today(2015/10/12)在网上搜索iOS对应的文档生成工具也还是Doxygen,HeaderDoc和appledoc，好像几年前就一直是这样了0.0。

1.Doxygen可适用于C、C++之类的，但不是我要的。

2.HeaderDoc是Xcode自带可生成html文档，且命名格式和官方相近。

3.appledoc生成的文档可在Xcode中查看到，并可在编辑代码时对应查看。

综上，Doxygen就这样，HeaderDoc和appledoc在接下来会给到对应安装以及使用介绍，主要给我个人后续查看0.0

---

一、HeaderDoc的使用

1.Xcode自带，不用安装0.0

2.在终端使用以下命令进行导出和生成文档：

headerdoc2html -o OutputDirectory InputDirectory

gatherheaderdoc OutputDirectory TOC.Html

3.然后在浏览器中打开TOC.Html(如未填写则默认masterTOC.html)文件便是代码的注释文件。

注意：

OutputDirectory目录是文档导出的目录，而InputDirectory目录是工程文件存在的目录。

代码中注释需要使用/*!注释内容*/才会被识别。

参考：

HeaderDoc的官方介绍文档

HeaderDoc Tags(HeaderDoc注释)

使用Xcode HeaderDoc和Doxygen文档化你的Objective-C和Swift代码

---

二、appledoc的使用

1.安装方法1：通过github工具

前提：有安装Xcode和命令行工具，并先装好github工具

在命令行中下载安装appledoc:

git clone git://github.com/tomaz/appledoc.git

cd appledoc

sudosh install-appledoc.sh

安装方法2：使用brew  不介绍

2.使用appledoc生成文档

使用终端cd到待生成的工程目录

appledoc -o ./doc --project-name 项目名 --project-company 公司名 .

以上项目名和公司名公司名替换成正常的名称，/doc可改成对应的路径

appledoc 会扫描当前路径下的所有文件，然后生成好文档放到 doc 目录下。然后就可以到Xcode的文档目录下进行查看：

参考：

appledoc官方文档

github下载地址

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