@exports - JsDoc Toolkitを使う！

トップページ > ドックコメントの書き方 > タグリファレンス >

@exports

@exportsタグはある要素を、コードとは異なる名前を持つ異なる要素としてドキュメントに出力できるようにします。コード内では別名で記述されている要素を、本来の名前を使ってドキュメント化したいという場合に役に立つでしょう。

• http://code.google.com/p/jsdoc-toolkit/wiki/TagExports
• 導入バージョン -- 2.2.0

構文

@exports codedName as documentedName

• codedName -- 必須：コード内で使われている名前
• documentedName -- 必須：ドキュメント化するときに使用したいネームパス

例

/** @namespace */

var mxn = {};

(function() {

    /** @exports Map as mxn.Map */

    var Map =

        /** @constructor */

        mxn.Map = function() {
        };

    /** This will be documented as a method of mxn.Map. */

    Map.prototype.doThings = function() {
    };
})();

１つのドックコメントの中に複数の@exportsタグをまとめて記述することができます。別名が作成されているコードに隣接してドックコメントを書くのは良い考えですが、この場合は必須ではありません。

---