为了账号安全,请及时绑定邮箱和手机立即绑定

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

函数表示

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

实例
Argument Type Required Description
selector String|Object Yes A CSS selector or a component
attributes Object No HTML attributes or element properties
children Array<Vnode>|String|Number|Boolean No Child vnodes. Can be written as splat arguments
returns Vnode A vnode
解释
功能 语法 解释
类型可变 String\|Object 可以是String或Object类型。
数组指定类型 Array<String> 数组内类型必须是String。
对象指定类型 Object<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>` | 数组内类型必须是String。
对象指定类型 | `Object<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为了撑开。

点击查看更多内容
TA 点赞

若觉得本文不错,就分享一下吧!

评论

作者其他优质文章

正在加载中
软件工程师
手记
粉丝
1.6万
获赞与收藏
893

关注作者,订阅最新文章

阅读免费教程

  • 推荐
  • 评论
  • 收藏
  • 共同学习,写下你的评论
感谢您的支持,我会继续努力的~
扫码打赏,你说多少就多少
赞赏金额会直接到老师账户
支付方式
打开微信扫一扫,即可进行扫码打赏哦
今天注册有机会得

100积分直接送

付费专栏免费学

大额优惠券免费领

立即参与 放弃机会
意见反馈 帮助中心 APP下载
官方微信

举报

0/150
提交
取消