1

緩い拡張を使用するモジュールにjsdocドキュメントを追加する適切な方法は何ですか?あるいは、実装を間違って設定するだけですか?最終的に私の共有メンバーが最終的な文書に含まれることを期待しています。緩い拡張モジュールを持つJSDocが一部のアイテムを解析しない

ルース拡張モデル(as described here)を使用して作成したモジュールでJSdocを使用しようとしています。モジュールはのラインに沿っている:私はこのコードでJSDocのを実行すると

/** 
* @module awesomeModuleToDocument 
* @description This module will make you awesome when setup and parsed correctly. 
*/ 
var awseomeModuleToDocument = (function() { 

var _moduleReturnObject = {}; 

/** 
* These awesome things are not shared but do get parsed as expected. 
* @alias module:awesomeModuleToDocument.privateThingsThatAreAwesome 
* @readonly 
* @enum 
*/ 
var privateThingsThatAreAwesome = { 
    /** 0 */ 
    'Unicorns' : 0, 
    /** 1 */ 
    'Bigfoot' : 1 
}; 

/** 
* These awesome things are shared but do not get parsed as expected. 
* @alias module:awesomeModuleToDocument.publicThingsThatAreAwesome 
* @readonly 
* @enum 
*/ 
_moduleReturnObject.publicThingsThatAreAwesome = { 
    /** 0 */ 
    'Beards' : 0, 
    /** 1 */ 
    'Goats' : 1, 
    /** 2 */ 
    'GoatBeards' : 2, 
}; 

    return _moduleReturnObject; 

}(awseomeModuleToDocument || {})); 

しかし、私はprivateThingsThatAreAwesomeではなく、公共のバージョンを含む出力を取得します。さらに、私が@aliasタグをプライベート列挙体のために取り出した場合、私はそれも出力に表示されません。

私の想定では、@aliasタグは公開されたケースでは正しく使用されていませんが、いくつかのテストと検索で私はどこにもいませんでした。

JSDocの3.4.3のための私の出力は、次のとおりです。ただし

/** 
* These awesome things are now parsing as I expected. 
* @memberof module:awesomeModuleToDocument 
* @alias module:awesomeModuleToDocument.publicThingsThatAreAwesome 
* @readonly 
* @enum 
*/ 
_moduleReturnObject.publicThingsThatAreAwesome = {...} 

:予想されるドキュメントの結果、私を与えるように見えた @memberofタグを追加もう少しこの遊んNot awesome JSDOC output

答えて

1

、私はまだこれについて行くより "preffered"方法があると思います。

関連する問題