appledoc安装及使用教程

1.安装

正常安装

git clone git://github.com/tomaz/appledoc.git

cd ./appledoc

sudo sh install-appledoc.sh

Home-brew安装

brew install appledoc

2.使用

举例：帮助桌面上的AFNetworking工程生成appledoc文档，在桌面上生成html文件，不生成docket类型，文件名字是AFNetworking，公司名字是rea,公司id是com.rea


命令行输入:

appledoc –no-create-docset –output ~/Desktop –project-name AFNetworking –project-company rea –company-id com.rea ~/Desktop/AFNetworking

–no-create-docset //不生成docset类型，生成html

–output ~/Desktop //文档生成的位置
–project-name AFNetworking //文档名字，建议与工程名字保持一致，方便识别

–project-company real
–company-id com.rea //公司的id


~/Desktop/AFNetworking //你要生成文档的注释类所在的文件目录，及工程目录

在桌面上出现html文件，点击打开index.html即可

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