简单使用appledoc 简单使用appledoc

1. 下载appledoc对应的有两种方式
1. 直接下载对应的工程，或者用guthub客户端下载 2.使用终端下载appledoc 最后安装

cd到对应的appledoc目录下 sudo sh install-appledoc.sh

appledoc github地址
生成文档
在终端cd到对应的工程的目录下，用如下命令：

appledoc --project-name="projectName" --project-version="3.1.0" --project-company="companyName"--company-id="companyID"--output="./"--docset-install-path="./".

注意：最后一定要加一个空格和点

上面的projectName和companyName必须写（用这种方法不必再写脚本了）companyID填写对应的BundleID就可以了。

最后输出的./这个可以自己写对应的路径。
或者：

appledoc --project-name 你的项目名称 --project-company 你的公司名称 ./

注释
注释使用headerDoc就可以了，或者vvdoccument也可以
最好参考开源的大V写的注释格式。
生成的文件如下

文章图片
111.png
然后右键点击.docset文件显示包内容

文章图片
1111.png

文章图片
11111.png 对应的在Xcode里面写成的注释就行了
2. 想要集成到Xcode中去需要添加aggregate File->New->Target 出现下面的图

文章图片
Aggregate.png

文章图片
add Run Script.png

文章图片
runScript.png
将下面的脚本添加到runScript中去，然后选择target编译就可以在项目中使用了

#appledoc Xcode script # Start constants company="ACME"; companyID="com.ACME"; companyURL="http://ACME.com"; target="iphoneos"; #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}"

谢谢那些开源的作者的帮助。
【简单使用appledoc】参考资料
下面这个有集成appledoc到Xcode中
http://www.cocoachina.com/ios/20161125/18183.html