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() { 

}; 

类定义：

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

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

}; 

您还可以定义文件本身：

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