documentation - 如何使用 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 组件语法可以有其自己的附加含义。例如，您可能需要注释@elementor之类的@lifecycleCallback东西。这不是由 jsdoc 提供的，因此例如 Polymer 使用它自己的文档注释使用core-component-page.

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