/// 这是单行注释。
/** 这也是单行注释 */
/*! 同样是单行注释 */
/** 这也是单行注释，
* 第二行会接上第一行。
*/
/** 第一行是类的简介
在简介的下面,就是类的详细介绍了。
没有间隔换行会被消除，就像Html那样。
下面是常用的markdown语法
- - -
无序列表: (每行以 '*'、'-'、'+' 开头):
* this is the first line
* this is the second line
* this is the third line
有序列表:(每行以1.2.3、a.b.c开头):
a. this is the first line
b. this is the secode line
多级列表:
* this is the first line
a.this is linea
b.this is line b
* this is the second line
1.this in line 1
2.this is line 2
标题:
# This is an H1
## This is an H2
### This is an H3
#### This is an h4
##### This is an h5
###### This is an H6
链接:
普通URL直接写上，appledoc会自动翻译成链接:http://blog.ibireme.com
[这个](http://example.net/)链接会隐藏实际URL.
表格:
|header1|header2|header3|
|---------|:-------:|--------:|
|normal|center|right|
|cell|cell|cell|
引用:
这里会引用到方法`someMethod:`，这里会引用到类`YYColor`
这里会引用到一个代码块
void CMYK2RGB(float c, float m, float y, float k,
float *r, float *g, float *b) {
*r=(1 - c) * (1 - k);
*g=(1 - m) * (1 - k);
*b=(1 - y) * (1 - k);
}
@since iOS5.0
*/
@interface AppledocExample : NSObject
///这里是属性的说明
@property(nonatomic,strong) NSString*name;
/**
@brief 这里是方法的简介。该Tag不能放到类注释里。
@exception UIColorException这里是方法抛出异常的说明
@see YYColor
@see someMethod:
@warning 这里是警告，会显示成蓝色的框框
@bug 这里是bug，会显示成黄色的框框
@param red 这里是参数说明1
@param green 这里是参数说明2
@param blue 这里是参数说明3
@return 这里是返回值说明
*/
-(UIColor *)initWithRed:(int)red green:(int)green blue:(int)blue;
-(void)someMethod:(NSString*)str;
@end
注意: 不管是直接使用终端还是集成到xcode,AppleDoc 使用的时候如果项目中有pod第三方的会报错。无法生成 docset-installed.txt和文档。 此时此时你可以 cd 到你项目的代码文件夹，再去执行脚本.
结果出现
Generation step 4/4 failed: GBDocSetInstallGenerator failed generating output, aborting! Documentation set was installed, but couldn't reload documentation within Xcode. Expected end of line but found identifier.
