如何在 JSDoc 中注释整个文件？

Question

我正在尝试评论描述整体功能的整个文件。我把这样的东西放在每个文件的顶部

/**
 * @file File with helper functions that facilitate reading config JSON files.
 */

但是当我生成文档时，我最终在每个文件之前都有一个奇怪的索引标题。看起来像这样：

我没有对默认的 JSDoc 配置进行任何更改。我做错了什么吗？指数标题是什么？我可以摆脱它或将其更改为有意义的东西吗？

Answer 1

“索引”标题是 JSDoc 为文件生成文档时的默认行为。要更改它，您可以执行以下操作：

使用@module而不是@file：这将显示模块名称而不是“Index”。

javascript

/**

• @模块配置读取器
• @description 用于读取配置 JSON 文件的辅助函数。 */

使用自定义 JSDoc 模板：您可以切换到像 Minami 这样的模板以获得更清晰的输出。例如：

重击

npm install minami --save-dev jsdoc -t ./node_modules/minami

修改 jsdoc.json 配置：调整 jsdoc.json 文件以自定义输出或抑制默认文件索引。

这将允许您用更有意义的内容替换或删除“索引”标题。