如何省略JsDoc中的源链接?

时间:2014-01-03 15:49:47

标签: jsdoc jsdoc3

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

1 个答案:

答案 0 :(得分:20)

如果您使用默认模板,请使用templates.default.outputSourceFiles设置为false的配置文件。例如:

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

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

我没有在任何实际的jsdoc文档中看到此选项。我在this issuethis one中找到了它。

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