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

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

Answer 2

我在创建jsdoc 3模板方面有一些适度的经验，我查看了代码来检查你在问什么。这是我发现的：

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

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

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

我可以让JsDoc3省略<footer>标记及其中的日期吗？</footer>

2 个答案: