Javascript YUIDocs解析聚合物元素
我试图记录一系列聚合物网络组件。我在过去使用过,但发现它不像YUIDocs或其他类似JSDocs的工具那样完整和可扩展。YUIDocs似乎是记录大型项目/前端和后端代码以创建单个可维护文档源的更好选择 有没有办法让YUIDocs在HTML注释块内或自定义元素的Javascript YUIDocs解析聚合物元素,javascript,documentation,polymer,yuidoc,Javascript,Documentation,Polymer,Yuidoc,我试图记录一系列聚合物网络组件。我在过去使用过,但发现它不像YUIDocs或其他类似JSDocs的工具那样完整和可扩展。YUIDocs似乎是记录大型项目/前端和后端代码以创建单个可维护文档源的更好选择 有没有办法让YUIDocs在HTML注释块内或自定义元素的标记内解析脚本块 我试过: <!-- /** * Description * *@class kiosk-pager *@constructor */ --> <polymer-element name="kiosk-p
标记内解析脚本块
我试过:
<!--
/**
* Description
*
*@class kiosk-pager
*@constructor
*/
-->
<polymer-element name="kiosk-pager" attributes="settings pagingRate pageDelay pollRate autoPaging "> //etc
//等
此外:
//模板
/**
*描述
*
*@班级信息亭寻呼机
*@建造师
*/
到目前为止,YUIDocs还没有在上面的评论中找到并添加我的类声明
感谢您的帮助。以下是我如何将其用于聚合物的示例
<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>
/**
元素描述
我是一个可爱的习惯元素
@类myelement
**/
/**
对财产的描述
@属性属性名
**/
将所有元素的代码放在这里
有一个相关问题。欢迎你的意见
<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>