1

一連の Polymer Web コンポーネントを文書化しようとしています。過去にPolymer/core-docs-viewerを使用したことがありますが、YUIDocsやJSDocsのようなものほど完全ではなく、拡張可能ではありません。YUIDocs は、より大きなプロジェクト/フロントエンドとバックエンドのコードを文書化し、単一の保守可能なドキュメント ソースを作成するためのより良い選択のようです。

HTML コメント ブロック内または<script>カスタム要素のタグ内のスクリプト ブロックを解析する YUIDocs を取得する方法はありますか?

私はもう試した：

<!--
/**
* 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 は上記のコメントで私のクラス宣言を見つけて追加していません。

任意の支援をいただければ幸いです。

4

2 に答える 2

2

以下は、Polymer での使用例です。

<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>
于 2015-06-26T05:37:29.720 に答える
1

関連する問題があります。あなたのアイデアは大歓迎です。

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

于 2015-07-05T08:22:56.087 に答える