jsdoc - 如何在 JsDoc 中省略源链接？

Question

导致 JsDoc 遗漏源链接的最简单方法是什么？我必须定义自己的模板吗？

score 32 · Accepted Answer

如果您使用默认模板，则使用templates.default.outputSourceFiles设置为false. 例如：

{
    "templates": {
        "default": {
            "outputSourceFiles": false
        }
    }
}

您可以使用-c命令行上的选项将此文件的路径传递给 jsdoc。

我没有在任何实际的 jsdoc 文档中看到此选项。我发现在这个问题和这个问题中提到了它。

模板是提供此功能的实体，因此如果您使用默认模板以外的其他模板，则必须检查其文档以查找是否有可以设置的设置来执行此操作。

score 1 · Accepted Answer

为了删除源文件链接，我们需要创建一个名为jsdoc.json并添加的文件：

{
    "templates":{
      "default":{
        "outputSourceFiles":false
      }
    }
}

然后运行：

jsdoc -c jsdoc.json calculator.js

这calculator.js是主文件（您将要记录的实际文件）并且jsdoc.json是配置文件。要运行我使用的配置文件–c选项。

所以，基本上你需要做的就是创建一个名为的文件jsdoc.json并添加上面提到的代码并保存它。保存后运行此命令：

jsdoc -c jsdoc.json calculator.js

2 回答 2