我可以让JsDoc3省略包含日期的<footer>标记吗？

Question

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

Answer 1

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

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

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

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

Answer 2

我为这个问题(https://github.com/jsdoc3/jsdoc/pull/916)提交了一个PR，现在它在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模板。