javascript - 如何在 JSDoc 中评论整个文件?
问题描述
我试图评论描述整体功能的整个文件。我把这样的东西放在每个文件的顶部
/**
* @file File with helper functions that facilitate reading config JSON files.
*/
但是当我生成文档时,我最终在每个文件之前都有一个奇怪的索引标题。它看起来像这样:
我没有对默认的 JSDoc 配置进行任何更改。难道我做错了什么?那个索引标题是什么?我可以摆脱它或将其更改为有意义的东西吗?
解决方案
推荐阅读
- javascript - 对象作为 React 子级无效(找到:[object HTMLDivElement])
- javascript - Angular 6:不能绑定到“formGroup”,因为它不是“form”的已知属性?
- c# - 属性初始化器不能引用非静态字段
- android - Java rx - 你应该使用 Single
- > 或者更确切地说是观察
- c++ - 如何通过 Cppcheck 解释 Null 指针取消引用?
- javascript - 自动调整标题大小似乎依赖于 PHP Echo。我不希望回声显示任何东西。
- javascript - 如果属性未定义或不存在
- html - 如何在网页中显示来自 FTP 服务器的图像
- php - symfony 4:Request.getScheme() 返回带有 X_FORWARDED_PROTO https 的 http
- android - 在 Android 中通过 CMake 使用 Tensorflow C++