如何使用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提供的，因此例如Polymer使用了它自己的文档注释，即core-component-page 。

您可以使用jsdoc提供的功能，并查看最适合您的用例的注释，或者使用dgeni之类的东西 ，它使您可以完全从头开始构建文档工具管道，从而可以完全控制注释等。