apple doc用来给项目自动生成文档, 体验和官方文档保持一致

  • 安装 git clone git://github.com/tomaz/appledoc.git

    cd ./appledoc

    sudo sh install-appledoc.sh

    appledoc –version

  • 生成项目文档

    cd /Users/akixie/Desktop/Xcode/AXKit/AXKit

    appledoc –project-name AXKit –project-company com.ak ./AXKit

    编译出的Docset默认会放在/Users/akixie/Library/Developer/Shared/Documentation/DocSets路径下

Docset格式，实际上是一个bundle,里面包含了一些xml和html。显示包内容后就可以查看和修改了。如果需要放到网站上，那单独将html部分取出来就行。

Docset安装后，在Xcode中就可以实时查看某个方法的说明了，体验和官方文档保持一致。（有一点，category中的注释不会出现在xcode的快速帮助中，

最终可以生成这样的效果：

appledoc还有很多不太完善的地方，比如C方法和宏定义上面的注释就不被识别，URL链接有时会识别错误等。。这时候只能手动修改生成好的html了；或者比较勤快自己手动fork一个appledoc改一下。。