为什么有时TSDoc中最重要的注释不会显示在生成的文档中？

Question

我正在使用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.
 */

有人知道为什么会发生这种情况吗?我该如何解决这个问题？

Answer 1

这取决于顶部注释和任何其他表达式之间是否有另一个注释。修复方法是在你的顶级评论后面加上另一个文档评论。

/**
 * 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中可以找到更多上下文。