从XCode里导出文档

从XCode里导出文档

在创建的文件里，必须按规定的格式书写注释

文件头：

/*!
 @header ViewController.h     //头文件
 @abstract 文件的摘要     //摘要
 @author Created by xxxx on 17/8/17.       //作者，创建时间
 @version 1.0.2 Creation                      //版本
 */

协议：

/*!
 @protocol XXXDelegate              //名称
 @abstract xxx的回调接口。     //摘要
 @discussion affewafawfawfawf .      //说明
 */

方法

oc
/*!
@abstract 不知道这是什么样的方法 // 摘要
@discussion 不知道这是什么样的方法 //说明
@param btn 点击的按钮 //参数
@result 返回title //返回值
*/


定义类：
oc
/*!
@class ViewController 类名
@abstract 测试注释。 摘要
*/


定义属性

oc
/*!
@property sName 属性
@abstract 名称 摘要
*/


定义方法：
oc
/*!
@abstract 不知道这是什么样的方法 //摘要
@discussion 不知道这是什么样的方法 // 说明
@param s wwwwwwwww 参数
@result 返回title //返回值
*/


枚举：

oc
/*!
@enum kType 枚举名称
@abstract 登录枚举 摘要
@constant LoginPass 密码登录 枚举内容一
@constant LoginWeixin 微信登录 枚举内容二
@constant LoginQQ QQ登录 枚举内容三
*/


项目中配置

导出：
添加新的Target: 类型为Cross-platform 的Aggregate
在该Target的Build Phases下，添加 New run script parse

内容：
oc
headerdoc2html -o ~/Desktop/doc ~/Desktop/kkkk
gatherheaderdoc ~/Desktop/doc index.html
exit 0