首页 > 解决方案 > 如何在 JSDoc 中评论整个文件?

问题描述

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

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

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

我没有对默认的 JSDoc 配置进行任何更改。难道我做错了什么?那个索引标题是什么?我可以摆脱它或将其更改为有意义的东西吗?

标签: javascriptjsdocjsdoc3

解决方案


推荐阅读