iOS 文档 - HeaderDoc

本文主要讲解一下，使用Xcode自带的HeaderDoc工具来自动生开发文档。

背景：公司要研发人员，必须给出开发文档。

这难不倒我们，哈哈哈！！

常用的自动生成文档，有三个：HeaderDoc、AppleDoc、和。。

我刚开始使用了AppleDoc，搞不定啊，我擦。

最终方案，使用HeaderDoc。

官方介绍：https://developer.apple.com/legacy/library/documentation/DeveloperTools/Conceptual/HeaderDoc/intro/intro.html#//apple_ref/doc/uid/TP40001215-CH345-SW1

使用方法，一般是将文件输出：

第一步：headerdoc2html -o ./Doc *.h

解释：-o 的意思是-output file；./Doc就是output的文件路径（在此是当前文件夹下，我自己建了一个Doc folder；*.h是指处理所有的.h文件）

第二步：gatherheaderdoc ./Doc index.html

xcode自带了headerDoc，它的路径是：~/Applications/Xcode-beta.app/Contents/Developer/usr/share/headerdoc