JavaScriptのAPIドキュメント生成ツールを調べてみたら、YUIDocが割とよかった

JavaScriptのAPIドキュメント生成ツール（いわゆるjavadocみたいなもの）を使いたくなったので、色々調べてみた。

jsdoc3

使い方が間違ってると指摘されたので、訂正エントリ書きました → 【訂正エントリ】jsdoc3の使い方が間違ってると指摘を受けたので再評価した - DenkiYagi

JavaScriptのAPIドキュメント生成ツールは現在もjsdoc系が主流のようなので、その最新系統のjsdoc3をまず試してみた。

jsdoc3/jsdoc · GitHub

zipをダウンロードして展開すると、JREさえインストールされていればすぐに使える（Rhinoのjarが同梱されている）。

で、実際に使ってみたのだが、以下のように即時関数内にドキュメントコメントを書いているケースではドキュメントが正常に生成されない。

/**
@module SampleModule
*/
var SampleModule = {};
(function () {
    /**
    Observer Pattern: Observable/Subject class

    @class Observable
    @constructor
    **/
    function Observable() {
        /**
        @property _observers
        @type Array
        @private
        */
        this._observers = [];

        /**
        @property _value
        @private
        */
        this._value = null;
    }
    SampleModule.Observable = Observable;

    // 以下略
})();