Documentation 如何使用jsdoc3记录web组件

Documentation 如何使用jsdoc3记录web组件,documentation,jsdoc,web-component,jsdoc3,x-tag,Documentation,Jsdoc,Web Component,Jsdoc3,X Tag,使用什么方法来记录web组件 下面是一个使用x-tag注册的web组件示例 xtag.register('x-analytics', { 生命周期:{ 已创建:函数(){ } }, 访问者:{ 代码:{ 属性:true }, 域:{ 属性:true } } }); 因为X-Tag也只是JavaScript,所以您可以简单地使用jsdoc提供的相应注释。所以像@memberof之类的事情 然而,Web组件语法可以有它自己的附加含义。例如,您可能需要@element或@lifecycleCallba

使用什么方法来记录web组件

下面是一个使用x-tag注册的web组件示例

xtag.register('x-analytics',
{
生命周期:{
已创建:函数(){
}
},
访问者:{
代码:{
属性:true
},
域:{
属性:true
}
}
});

因为X-Tag也只是JavaScript,所以您可以简单地使用jsdoc提供的相应注释。所以像
@memberof
之类的事情

然而,Web组件语法可以有它自己的附加含义。例如,您可能需要
@element
@lifecycleCallback
之类的注释。这不是jsdoc提供的,因此,例如Polymer使用
核心组件页面
使用自己的文档注释


您可以使用jsdoc提供的内容并查看哪些注释最适合您的用例,也可以使用类似的工具,完全从头开始构建文档工具管道,以便完全控制注释等。

“您只需使用jsdoc提供的相应注释即可”当前位置这是我的问题:有没有一种常用的方法?我是否应该使用
@lends
,使用
@typedef
等创建类型。没有什么可以阻止您这样做。