2016-10-10 4 views
0

私はJSのドキュメントを生成するためにJS Docを使用しています。私はいくつかの値を持つenumを持っています。私は各プロパティのドキュメントを生成したい。私は以下を試した:JS Docのenum値を文書化する方法

/** 
* Enum for display state. 
* @readonly 
* @enum {string} 
*/ 
var DisplayState = { 
    /** @member {string} */ 
    foreground: 'foreground', 
    /** @member {string} */ 
    background: 'background', 
    /** @member {string} */ 
    projected: 'projected' 
}; 

HTMLページが生成された後、私は、個々のプロパティではないenum型のdocしか見ない。

私は、次の/ **いくつかのコメント*// ** @member {文字列} * /および/ ** @property {文字列} *を試してみた/が、何も私はにアップグレード

+0

あなたは '@のmember'を削除しようとしたがありますか? –

+0

http://usejsdoc.org/tags-enum.html –

+0

はい、私は試しました1.メンバの削除2.プロパティの追加3.メンバとプロパティの削除 – Sai

答えて

0

を動いていないようにみえJS Doc(https://github.com/jsdoc3/jsdoc)のバージョン3とこの問題は修正されました。

以下の例を参照してください:

/** 
* Enum for display state. 
* @readonly 
* @enum {string} 
*/ 
var DisplayState = { 
    /** @member {string} */ 
    /** The app is running in the foreground and can receive user input. */ 
    foreground: 'foreground', 

    /** @member {string} */ 
    /** The app is in the background and can't receive user input. */ 
    background: 'background', 

    /** @member {string} */ 
    /** The app is running in Phone Projection mode (Android Auto or Apple Car Play). */ 
    projected: 'projected' 
}; 
関連する問題