如何在 JsDoc 中省略源链接？

Posted 2023-03-15

【中文标题】如何在 JsDoc 中省略源链接？

【英文标题】：How can I omit the source links in JsDoc?

【发布时间】：2014-01-21 08:24:23

【问题描述】：

让 JsDoc 忽略源链接的最简单方法是什么？我必须定义自己的模板吗？

【问题讨论】：

如果愿意，请投反对票，但请评论为什么？

【参考方案1】：

如果您使用默认模板，则使用将templates.default.outputSourceFiles 设置为false 的配置文件。例如：

    "templates": 
        "default": 
            "outputSourceFiles": false
        
    

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

我没有在任何实际的 jsdoc 文档中看到此选项。我在this issue 和this one 中发现了它。

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

【讨论】：

要完成，您可能需要同时设置 "outputSourceFiles" : false 和 "outputSourcePath" : false，如 github.com/terryweiss/docstrap#configuring-the-template 上所述

@Chris 如果您使用的是 Docstrap，那就对了，这与我关于使用默认模板以外的模板的最后一段有关。我刚刚为 outputSourcePath 获取了最新的稳定版 jsdoc，但无处可寻。

【参考方案2】：

为了移除源文件链接，我们需要创建一个名为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