-
Notifications
You must be signed in to change notification settings - Fork 270
API注释规范
ZhouZhen edited this page Dec 22, 2021
·
1 revision
@Nice-PLQ | 2020-03-21
@description API说明
@attribute 属性
@enum 可选值
@default 默认值
以Button
为例,这里只列举部分api
export default {
name: 'TButton',
props: {
/**
* @description 按钮类型
* @attribute type
* @enum ['default', 'primary', 'warning', 'gray']
* @default default
*/
type: {
type: String,
default: 'default',
validator: val =>
['default', 'primary', 'warning', 'gray'].indexOf(
val
) !== -1
},
/**
* @description 加载状态提示文字
* @attribute loading-text
*/
loadingText: String
}
};
以这种带关键字的注释的好处:
- 规范、清晰、直观
- 通过解析生成vetur的helper-json文件,实现API自动提示
访问 TDesign 官网