函数表示

有时候读别人的注释说明或许会有点难懂，其实都是有标准，简单学习下，方便阅读别人，也方便别人阅读你。

实例

Argument	Type	Required	Description
selector	String\|Object	Yes	A CSS selector or a component
attributes	Object	No	HTML attributes or element properties
children	Array\|String\|Number\|Boolean	No	Child vnodes. Can be written as splat arguments
returns	Vnode		A vnode

解释

功能	语法	解释
类型可变	`String\|Object`	可以是String或Object类型。
数组指定类型	`Array`	数组内类型必须是String。
对象指定类型	`Object`	对象的key是String，value是Object。
可选参数	`func1(a, [b, ]) c`	b参数为可选。
可变参数	`splat arguments`	指 `[a, b, c]` 可以写作 `a, b, c` ，一般需要具体说明，没找到什么具体语法。
函数签名	`(String, Array) -> String`	入参为String与Array，返回一个String，单个入参不用带括号。

Markdown表格写法：

功能 | 语法 | 解释
- | - | -
类型可变 | `String|Object` | 可以是String或Object类型。
数组指定类型 | `Array` | 数组内类型必须是String。
对象指定类型 | `Object` | 对象的key是String，value是Object。
可选参数 | `func1(a, [b, ]) c` | b参数为可选。
可变参数 | `splat arguments` | 指 `[a, b, c]` 可以写作 `a, b, c` ，一般需要具体说明，没找到什么具体语法。
函数签名 | `(String, Array) -> String` | 入参为String与Array，返回一个String，单个入参不用带括号。

两边竖杠可以省略。

Markdown对齐写法：默认abcdefg	左对齐abcdefg	居中abcdefg	右对齐abcdefg
a	a	a	a	a

默认abcdefg | 左对齐abcdefg | 居中abcdefg | 右对齐abcdefg
- | :- | :-: | -:
a | a | a | a | a

abcdefg为了撑开。

ITPub博客

函数文档表示规范，附Markdown表格写法

最新文章