appledoc官方原来是有一篇语法的，但是现在貌似维护中了。。所以这里尽量多介绍一下。
首先，文档中的注释只有符合规范，才能被appledoc认可。
凡是以 "///"、"/**"或"/*!"开头的注释块，都算所appledoc注释。下面是示例:
|
1
2
3
4
5
6
7
8
9
|
/// 这是单行注释。
/** 这也是单行注释 */
/*! 同样是单行注释 */
/** 这也是单行注释，
* 第二行会接上第一行。
*/
|
注释块中，每一行开头的空格和"*"字符多数情况都会被appledoc忽略。
连续的两行(即没有间隔空行)的注释，将被合并成一个段落，并忽略换行，就像html。
在注释块内，appledoc支持如下语法：Markdown、HTML、HeaderDoc Tags。
Markdown的语法在这里有介绍(中文翻译)，用Github的童鞋应该很熟悉。OSX上可以用Mou实时查看效果，Chrome也有一个插件来实时查看效果。这个东西可以说一看就会，学习成本很低。Markdown有很多方言，而且appledoc支持的也不算完整。所以用的时候可以试着在appledoc编译一下看看效果。
HTML这个就不用说了，支持Markdown肯定也支持HTML。。如果想要把控住更多细节，那就直接码Html吧。
HeaderDoc Tags这个东西是苹果的HeaderDoc工具的语法。详情可以见官网文档。例如@param、@return、@warning这样的东西，appledoc会进行解释。当然appledoc对这个东西的支持也不算完整 
所以用的时候也要尝试一下。
通常情况下，Xcode会给关键词高亮显示，就像下面这样：
下面是一些常用的语法示意:
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
|
/** 第一行是类的简介
在简介的下面,就是类的详细介绍了。
没有间隔换行会被消除，就像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 line a
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
|
编译出的效果是这样：
appledoc还有很多不太完善的地方，比如C方法和宏定义上面的注释就不被识别，URL链接有时会识别错误等。。这时候只能手动修改生成好的html了；或者比较勤快自己手动fork一个appledoc改一下。。
http://blog.ibireme.com/2013/08/26/appledoc-guide/
