如何使用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之類的東西 ，它使您可以完全從頭開始構建文檔工具管道，從而可以完全控制注釋等。