我可以让 JsDoc3 省略带有日期的 <footer> 标记吗？答案

【问题标题】：Can I cause JsDoc3 to omit the <footer> tag with the date in it?我可以让 JsDoc3 省略带有日期的 <footer> 标记吗？
【发布时间】：2015-02-11 20:41:55
【问题描述】：

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不输出这个页脚吗？

【问题讨论】：

标签： jsdoc jsdoc3

【解决方案1】：

我为此问题提交了 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 模板。

【讨论】：

【解决方案2】：

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

<footer> 硬编码在默认模板的 layout.tmpl 文件中。通过硬编码，我的意思是元素本身不是可选的。
我在默认模板的 publish.js 文件中没有看到任何代码在处理 layout.tmpl 时会以某种方式删除 <footer>。

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

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

【讨论】：