appledoc,方便的程序文档编写工具

appledoc是自动化文档生成工具，推荐大家使用

它默认生成的文档风格和苹果的官方文档是一致的，安装使用后，可以直接在Xcode中查看。
appledoc 就是用 objective-c 生成的，必要的时候调试和改动也比较方便。
可以生成 docset，并且集成到 Xcode 中。这一点做的非常好，相当于在源码中按住 option 再单击就可以调出相应方法的帮助。
它没有特殊的注释要求，可以用 /** */ 的格式，也可以兼容 /*! */ 的格式的注释，并且生成的注释有汇总页面。
安装

那么简单介绍一下如何安装 appledoc，安装非常简单，只需要 2 步：

1 2 3

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

使用
使用 appledoc 时，只需要用如下命令即可：

appledoc -o ./doc --project-name ynote --project-company youdao . 常用的命令PATHS  -o, --output <path>                     Output path  -t, --templates <path>                  Template files path      --docset-install-path <path>        DocSet installation path  -s, --include <path>                    Include static doc(s) at path  -i, --ignore <path>                     Ignore given path  -x, --exclude-output <path>             Exclude given path from output      --index-desc <path>                 File including main index description PROJECT INFO  -p, --project-name <string>             Project name  -v, --project-version <string>          Project version  -c, --project-company <string>          Project company      --company-id <string>               Company UTI (i.e. reverse DNS name) OUTPUT GENERATION  -h, --create-html                       [b] Create HTML  -d, --create-docset                     [b] Create documentation set  -n, --install-docset                    [b] Install documentation set to Xcode  -u, --publish-docset                    [b] Prepare DocSet for publishing      --html-anchors <string>             [*] The html anchor format to use in DocSet HTML.      --clean-output                      [b] Remove contents of output path bef

appledoc 会扫描当前路径下的所有文件，然后生成好文档放到 doc 目录下。你也可以用 appledoc —help 查看所有可用的参数。
详细的信息可以查看官方的文档：http://gentlebytes.com/appledoc/