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 では、基本的に jsdoc 3 にデフォルトのテンプレートを使用するように指示する可能性layout.tmplがありますが、別のファイルを使用すると、テンプレートのカスタマイズがはるかに簡単になります。

于 2014-01-20T12:57:14.083 に答える