文章/答案/技术大牛

发布

问jsdocs3无文档生成
EN

Stack Overflow用户

提问于 2016-05-14 14:17:53

回答 1查看 35关注 0票数 0

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

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

然后我运行命令./node/jsdoc/jsdoc.js ./app/app.js -r -d docs/，结果如下：

我还使用--debug param尝试了上面的命令，我可以看到jsdocs3能够解析文档并在没有任何错误的情况下完成。

我不知道我做错了什么。有什么可以帮忙的吗？

jsdoc3

javascript

node.js

回答 1

Stack Overflow用户

回答已采纳

发布于 2016-05-14 19:38:53

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
 */

票数 0

页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持

原文链接：

https://stackoverflow.com/questions/37227751

复制

相似问题

问jsdocs3无文档生成
EN

回答 1

Stack Overflow用户

社区

活动

圈层

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问jsdocs3无文档生成EN

回答 1

Stack Overflow用户

社区

活动

圈层

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问jsdocs3无文档生成
EN