apple风格的html文档生成

初衷

    上级领导要求我对目前的公司产品整一份SDK文档，为了以后便于维护以及让新人能更快的理解代码。手动写文档是件非常累人的事情，网上搜了一下，发现有从源码中抽取注释生成文档的专用工具，这一下子能减轻不少工作量。下面是从网上找到的工具简介。

1、appledoc：简单方便，适于生成apple风格的html文档，及直接集成到xcode帮助（docset）。官网 http://gentlebytes.com/appledoc/ 。
2、doxygen：功能强大，适于生成html文档与pdf文档。官网 http://www.stack.nl/~dimitri/doxygen/index.html 。

3、headerdoc：headerdoc的注释生成规则比较特别，只生成以 /*! */ 的格式的注释。还有一个缺点是每个类文件对应一个注释文件，没有汇总的文件，这点感觉有点不爽。

经过简单对比我决定采用appledoc，因为它能直接集成到时xcode帮助，下面我就说下我是怎么用它完成这个任务的。

快速文档注释

    使用appledoc生成文档的注释格式可以用/** */ 的格式，也可以兼容/*! */的格式的注释，并且生成的注释有汇总页面。如果每个方法注释都要自己手动去敲这个格式那就太效率就太低了，推荐给大家一个很好用的插件，可以帮助开发人员快速写注释，并且生成的注释风格完全兼容appledoc。
插件下载地址：https://github.com/onevcat/VVDocumenter-Xcode
插件安装：
安装该插件很简单，下载下来后你只需要打开该工程然后编译一下就OK了。然后关闭Xcode再重新打开，在你要生成注释方法的上面输入3个斜杠"///"，如下效果图：

appledoc安装

安装十分简单，只需要几步，打开终端，输入以下命令：

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

appledoc生成文档

通过下面的命令去生成文档：

appledoc --project-name YourProject --project-company YourCompany ProjectPath/