2015-03-15 3 views
1

Я пытаюсь документировать ряд полимерных веб-компонентов. Я использовал Polymer/core-docs-viewer в прошлом, но считаю, что он не такой полный и расширяемый, как YUIDocs или другие, подобные JSDocs. YUIDocs представляется лучшим выбором для документирования более крупных проектов/интерфейса и внутреннего кода для создания единого поддерживаемого источника документа.YUIDocs parse Полимерный элемент

Есть ли способ заставить 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 не нашел и добавил свое объявление класса в вышеуказанных комментариях.

Любая помощь оценили.

ответ

2

Вот пример того, как я использую его с полимером

<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> 
Смежные вопросы