YUIDocs 解析聚合物元素

Question

我正在尝试记录一系列聚合物Web组件。 我过去使用过Polymer/core-docs-viewer，但发现它不像YUIDocs或其他像JSDocs那样完整和可扩展。 YUIDocs 似乎是记录大型项目/前端和后端代码以创建单个可维护文档源的更好选择。

有没有办法让 YUIDocs 解析 HTML 注释块或自定义元素的 <script> 标记中的脚本块？

我试过：

<!--
/**
* Description
*
*@class kiosk-pager
*@constructor
*/
-->
<polymer-element name="kiosk-pager" attributes="settings pagingRate pageDelay pollRate autoPaging "> //etc

也：

<polymer-element name="kiosk-pager" attributes="settings pagingRate pageDelay pollRate autoPaging ">
//template
<script>
    /**
    * Description
    *
    *@class kiosk-pager
    *@constructor
    */

到目前为止，YUIDocs 还没有在上面的评论中找到并添加我的类声明。

任何帮助表示赞赏。

Answer 1

这是我如何将它与聚合物一起使用的示例

<script>
/**
    Description of element
        <myelement>I am a sweet custom element</myelement>
    @class myelement
**/
/**
    A description of a property
    @attribute property name
**/
</script>
<dom-module id="myelement">
    Put all of your element's code here
</dom-module>
<script src="./i_keep_the_js_seperate.js"></script>

Answer 2

有一个相关的问题。欢迎您的想法。

https://github.com/yui/yuidoc/issues/328