3

JSDoc 在每个页面的页脚输出一个日期：

<footer>
    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0</a> on Fri Jan 17 2014 14:30:54 GMT-0800 (PST)
</footer>

因此，每当我重建我的库时，所有文档文件看起来都已更改为 Git。这是不可取的——我只想在这些文档的内容实际发生变化时提交这些文档。

我可以让 JsDoc根本不输出这个页脚吗？

4

2 回答 2

4

我为这个问题提交了一个 PR ( https://github.com/jsdoc3/jsdoc/pull/916 )，它现在在 3.3.0 分支上。

在我撰写此答案时，此更改尚未发布到 NPM，但您可以要求 git 的 3.3.0 分支：

"jsdoc": "git+https://git@github.com/jsdoc3/jsdoc.git#releases/3.3"

之后，您可以将以下字段添加到配置文件中：

{
    ...
    "templates": {
        ...
        "default": {
            "includeDate": false
        }
    },
    ...
}

请注意，此选项仅适用于默认的 jsdoc 模板。

于 2015-02-11T12:41:55.737 回答
3

我在创建 jsdoc 3 模板方面有一些经验，并且我查看了代码以检查您的要求。这是我发现的：

  • <footer>在默认模板的layout.tmpl文件中硬编码。通过硬编码，我的意思是元素本身不是可选的。

  • 我没有看到默认模板文件中的任何代码在处理时publish.js会以某种方式删除。<footer>layout.tmpl

因此，要删除此页脚，您必须使用自定义模板或对 jsdoc 3 生成的文件进行某种后处理。

对于 3.3.0 之前的版本，<footer>从模板中删除意味着复制整个默认模板并将更改为layout.tmpl. 版本 3.3.0，目前处于 alpha 阶段，将提供基本上告诉 jsdoc 3 使用默认模板但使用不同layout.tmpl文件的可能性，这将使自定义模板更加容易。

于 2014-01-20T12:57:14.083 回答