jsdocs3ドキュメントが生成されていません

Question

これは初めてjsdocs3を使用しているため、ドキュメントを生成できません。 は、私はファイルapp.jsを作成し、以下のコメントを挿入： - 私は、コマンドを実行した後

/** 
* Main file - All modules are loaded. 
* @author My Name 
* 
*/ 

を./node_modules/jsdoc/jsdoc.js ./app/app.js -r -dドキュメント/その結果は以下の通りである： -

私も--debugのPARAMで上記のコマンドを試してみましたが、私はそれjsdocs3は、文書を解析することができ、任意のせずに終了します見ることができましたエラー。

私は何が間違っているのか分かりません。どんな助けもありがたいですか？

Answer 1

jsdocは、構文解析とjsdocコメント解析の両方に関するドキュメントを生成します。 ファイルには、jsdocが認識する関数/オブジェクト/モジュール定義が必要です。

モジュール・エクスポートのどちらか：

/** 
* Fooer 
*/ 
module.exports.foo = function() { 

}; 

クラス定義：

/** 
* Awesome module. 
* @author John Doe 
* @file test.js 
*/ 

：あなたはまた、ファイル自体を定義することができ

/** 
* Some class. 
* @constructor 
*/ 
function SomeClass() { 

    /** 
    * Foo it 
    * @param x data 
    */ 
    this.foo = function(x) { }; 

};