jsdocs3 没有文档生成

Question

这是我第一次使用 jsdocs3，我无法生成文档。 我创建了一个文件 app.js 并插入了以下注释：-

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

然后我 运行 命令 ./node_modules/jsdoc/jsdoc.js ./app/app.js -r -d docs/ 结果是如下所示：-

我也尝试过使用 --debug 参数执行上述命令，我发现 jsdocs3 能够解析文档并顺利完成。

我不知道我做错了什么。感谢任何帮助？

Answer 1

jsdoc 生成有关语法分析和 jsdoc 注释分析的文档。 您的文件中需要一些 jsdoc 可以识别的 function/object/module 定义。

任一模块导出：

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

};

一个class定义：

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

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

};

您也可以定义文件本身：

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