appledoc文档生成工具

前言

在移动开发的今天，为了多项目进行开发，需要编写一些项目文档。对于开发者而言，项目源码和文档最好是放在一起，这样更新源码与项目时都会更将方便。

java语言本身自带了javadoc命令，可以从源码中抽取文档，非常方便。apple中也有类似的objective-c语言的类似工具。

本文介绍一下appledoc的使用。

appledoc

appledoc是在stackoverflow上被大家推荐使用的一种注释工具，基于以下几点，个人比较喜欢使用它：

1. 它默认生产成本的文档风格与官方文档一致。

2. appledoc 用oc生成，调试与改动比较方便。

3. 可生成docset，继承至xcode中，在源码中按住option再单击就可以调出相应方法的文档注释。

4. appledoc的源码在github上。

5. 无特殊的注释要求。

/*! */

/** */

都可以生成。

appledoc的安装

在terminal中输入：

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

appledoc的使用

需要生成文档时，只需要使用如下命令：

appledoc -o ./doc --project-name 'your name' --project-company 'your company' .

参考:

appledoc官方文档