appledoc自动生成技术文档

安装appledoc

执行如下命令

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

安装成功有如下提示

** INSTALL SUCCEEDED **

生成文档

话不多说，直接上图

appledoc自动生成文档命令解释.png

其中最后一个参数可脱离原工程的意思是，可以直接将一个工程里的几个文件单拿出来，放到一个文件夹里，传入这个文件夹的路径。我们可以实操一遍。
比如我们这里有个工程 testdoc, 创建testdoc1，testdoc2，testdoc3（其中testdoc1引用了testdoc2，testdoc2引用了testdoc3，这里不截图了）

[email protected]

[email protected]

然后我们把这三个的testdoc的.h文件复制出来放到一个文件夹里，

[email protected]

终端cd进入这个文件夹，输入如下命令：

appledoc --no-create-docset --output ~/Desktop/test1234  --project-name "testdoc" --company-id "testdoc"  --project-company "testdoc" ~/Desktop/test1234

生成一个html文件夹

[email protected]

打开里边的index.html

[email protected]

大功告成

ps：好多文章都说需要创建aggregate，还要写脚本，其实根本不用，只要一行命令，把相关的设置设置好就行了。