appledoc

Objective-C API文档生成器

参考文

iOS使用appledoc 生成技术API文档详解
iOS使用appledoc来创建开发文档（装逼使用）
iOS - appledoc 文档添加

再学习Android时，重温JAVA发现，JAVA能生成API文档，心里突然想：不对啊，我大iOS怎么可能没有呢？于是......

安装

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

使用brew安装

brew install appledoc

验证

appledoc --version

我安装的版本: appledoc version: 2.2.1 (build 1334)

使用

方式一：

CD进入项目目录,复制粘贴下面命令

appledoc --project-name projectName --project-company abc ./

你会在你的项目目录中发现docset-installed.txt文件，内容如下

Documentation set was installed to Xcode!

Path: /Users/*****/Library/Developer/Shared/Documentation/DocSets/com.abc.myproject.projectName.docset
Time: 2018-01-27 09:32:14 +0000

这种方式简单粗暴，但想要格式出想要的，恐怕这一条是不够的。

方式二：

新建：New -> Target -> Cross-platform ->Aggregate
会在PROJECT下创建新文件

f60edb4b-f070-4673-9fb4-cd57c5da301d.png

63802900.png

在Build Phases 新建 Run Script 拷贝下面代码

我借鉴别人的。

#appledoc Xcode script
# Start constants

company="abc";
companyID="com.abc";
companyURL="http://www.abc.com";
target="iphoneos";
#target="macosx";
outputPath="../Documents";
# 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}"

问题

Command /bin/sh failed with exit code 127

可能也遇见了250

因为的Pods问题，我忽略了一个文件夹Pods文件夹。运行通过,每一行不能存在空行

--ignore ".../.../.../Pods" \

对于注释：XCode给定的快捷键option+command+/

/**
 公历类   【对类进行说明】
 */
@interface Solar : NSObject
/**
 *公历 日 【对属性进行说明】
 */
@property(assign) int solarDay;
/**
 *公历 月
 */
@property(assign) int solarMonth;
/**
 *公历 年
 */
@property(assign) int solarYear;
@end

/**
 完成点击
 @param model 结果
 */

-(void)complete:(DateModel *)model{
    //todo
}

基本操作已完成，接下来就是认真的熟悉每一个命令

help

Find more help and tips online:

• http://appledoc.gentlebytes.com/
• http://tomaz.github.com/appledoc/

• [b] 布尔参数，不使用任何值，使用-no-前缀来否定。
• [*] 表示参数接受占位符字符串

path[路径]

PROJECT INFO[项目信息]

OUTPUT GENERATION[生成输入]

OPTION[选项]

WARINGS[警告]

MISCELLANEOUS[杂项]

DOCUMENTATION SET INFO[文档设置信息]

• - %PROJECT 取代 --project-name
• - %PROJECTID 取代标准 --project-name
• - %VERSION 取代 --project-version
• - %VERSIONID 取代 --project-version
• - %COMPANY 取代 --project-company
• - %COMPANYID 取代 --company-id
• - %YEAR 取代当前年份 (format yyyy)
• - %UPDATEDATE 取代当前日期 (format yyyy-MM-dd)
• - %DOCSETBUNDLEFILENAME 取代 --docset-bundle-filename
• - %DOCSETATOMFILENAME 取代 --docset-atom-filename
• - %DOCSETPACKAGEFILENAME 取代 --docset-package-filename