appledoc生成开发文档

今天看到一篇文章，有一款插件用来生成开发文档的，就学习测试了下，很方便，生成的效果也非常不错

VVDocment一般都有使用，增加注释的，而appleDoc可以把有注释的项目，自动生成html页面，自己可以另行编辑为doc开发文档。

appleDoc安装非常方便：

我使用的是clone的方式，克隆项目到本机，然后安装

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

cd ./appledoc

sudo sh install-appledoc.sh

安装后确认下是否安装成功

appledoc --version

进入code所在目录，跑一下下面的命令，默认会编译出docset并安装进Xcode。

appledoc --project-name MyProject --project-company ibireme ./

之后需要在某个项目集成，

1.选中你的工程,点击Add Target按钮,选择 Other -> Aggregate模板新建.
2.点击Add Build Phase按钮,添加一个Run Script.
3.把下面的模板代码复制进去,把前几行参数改成你自己的.

#appledoc Xcode script

# Start constants

company="XXXX.com";

companyID="XXXX";

companyURL="XXXX";

target="XXXX";

#target="macosx";

outputPath="~/help";

# End constants

/usr/local/bin/appledoc \

--project-name "${PROJECT_NAME}" \

--project-company "${company}" \

--company-id "${companyID}" \

--docset-atom-filename "${company}.atom" \

--docset-feed-url "${companyURL}/${company}/%DOCSETATOMFILENAME" \

--docset-package-url "${companyURL}/${company}/%DOCSETPACKAGEFILENAME" \

--docset-fallback-url "${companyURL}/${company}" \

--output "${outputPath}" \

--publish-docset \

--docset-platform-family "${target}" \

--logformat xcode \

--keep-intermediate-files \

--no-repeat-first-par \

--no-warn-invalid-crossref \

--exit-threshold 2 \

"${PROJECT_DIR}"

4.在Xcode左上角选择这个新建的Target,然后点击build即可

编辑后的文档在clone的项目文档旁边，help目录里边

可以生成docset文件夹(xcode帮助文档）、html文件夹(html注释页面)

另外编辑新项目会自动删除原项目生成的文档

至于AppleDoc的语法另行查询。目前使用VVDocment的注释语法可以满足需求。