为什么有时在生成的文档中没有显示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中找到更多上下文。