headerdoc

本文主要介绍如何利用xcode自带工具headerdoc文档化代码

核心命令

headerdoc2html -o ~/Desktop/documentation *.h
gatherheaderdoc .
VVDocumenter-Xcode

headerdoc对代码格式有严格要求，如下:

/*!
 *  @author luojun yan, 2016-02-16 14:02:39
 *
 *  @brief 查找vc里面是否包含gobackurl
 *
 *  @param urlStr 要返回的目标webview对应的url
 *
 *  @return webview在vc中的索引
 */
 - (NSInteger)getShouldReturnWebViewIndexWithOnBackURLStr:(NSString *)urlStr;

生成文档步骤：
cd到要文档化的文件目录下

headerdoc2html -o ~/Desktop/documentation *.h

解释一下：
headerdoc2html：命令写死
-o： 代表输出
~/Desktop/documentation: 输出文档的目录地址,没有会自动新建
.h:需要被文档化的文件，.h代表当前目录下的所有.h文件；这边可以指定单个文件，或者其他目录的文件

查看目标目录，会看到很多xxx_h文件夹，里面一般有两个html文件,一个index.html,toc.html.

至此源码的文档化已经完成，是不是觉得一个一个文档都是孤立的，难以查阅。
我们还有命令gatherheaderdoc，，为文档创建目录和索引，方法如下：
cd到刚才的文档目录下：

cd ~/Desktop/documentation

执行命令，注意后面有一个点

gatherheaderdoc .

点 代表当前目录，也可以传入其他目录地址.
大功告成，看下目录是不是多了一个masterTOC.html文件

xcode源码注释工具，自动生成符合headerdoc格式的注释，插件下载地址:VVDocumenter-Xcode
下载源码，xcode直接打开编译即可，重启xcode,window下面会多出一个VVDocumenter选项，点击可以设置注释偏好，例如作者，时间等