appledoc 使用方法

来源：互联网发布：php程序员如何提高水平编辑：程序博客网时间：2024/06/07 06:10

第一步：克隆代码

git clone git://github.com/tomaz/appledoc.git   /指定目录

第二步：进入代码所在目录，执行安装脚本

sudo sh install-appledoc.sh

第三部：在项目中增加target用于生成说明文档

1⃣️在工程中 File－>New->Target->Other->aggregate2⃣️New Run Script Phase3⃣️脚本内容如下，酌情增删改

#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}"

最后：编译该target

自己工程遇到的执行错误

错误信息一： appledoc[13824:658676] * Assertion failure in +[GBMethodData methodDataWithType:result:arguments:], /Users/admin/Desktop/Git/appleDoc/Model/GBMethodData.m:44
此处代码以及解决方法：

+ (id)methodDataWithType:(GBMethodType)type result:(NSArray *)result arguments:(NSArray *)arguments {    //NSParameterAssert([arguments count] >= 1); //注释掉断言，重新执行安装脚本，强行走下去    return [[self alloc] initWithType:type attributes:[NSArray array] result:result arguments:arguments];}

错误信息二：
这里写图片描述
return 2，调查没有找到对最后生成文档有什么影响。

备注：
appledoc不支持swift，不能显示swift中的注释信息等
appledoc只显示含有注释的property，method，如果该类没有注释信息，将不会生成该类对应的说明文档

0 0