为什么有时 TSDoc 中最上面的注释没有显示在生成的文档中?

Why sometimes the top-most comment in TSDoc doesn't show in the generated documentation?

我正在使用 TSDoc 记录我的 TypeScript 项目并使用 TypeDoc 生成 HTML 文档。

我似乎无法找到答案,为什么文件中的置顶评论有时会出现在生成的文档中(这对于解释整个文件的用途很有用),有时却没有。

我尝试将在一个文件中有效的热门评论粘贴到另一个文件中,但它没有显示。注释格式正确。这是评论,以防相关:

/**
 * This file provides functions for interacting with CNPJ data.
 * You might want to use some more complex functions from the **cpf_cnpj** library.
 */

有人知道为什么会这样吗?我该如何解决这个问题?

这取决于置顶评论和任何其他表达之间是否有其他评论。解决方法是在您的顶级评论之后添加另一个文档评论。

/**
 * This file provides functions for interacting with CNPJ data.
 * You might want to use some more complex functions from the **cpf_cnpj** library.
 */
/** End file docs */

this issue 中找到更多上下文。