如何使用jsdoc3记录web组件

Question

使用jsdoc3记录web组件的方法是什么

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

xtag.register('x-analytics',
{
    lifecycle : {
        created : function(){
        }
    },
    accessors : {
        code : {
            attribute : true
        },
        domain : {
            attribute : true
        }
    }
});

Answer 1

由于X-Tag也只是JavaScript，您可以简单地使用jsdoc提供的相应注释。像@memberof之类的东西。

但是，Web组件语法可以有其自己的附加含义。例如，您可能需要@element或@lifecycleCallback等类似内容的注释。这不是由jsdoc提供的，因此，例如，聚合物使用它自己的文档注释使用core-component-page。

您可以使用jsdoc提供的内容并查看哪些注释最适合您的用例，也可以使用诸如dgeni之类的工具，它允许您完全从头开始构建文档工具管道，因此您可以完全控制您的注释等。