typescript - 为什么有时 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.
 */

有谁知道它为什么会发生，我该如何解决这个问题？

标签： typescripttypedoc

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 */

在这个问题中可以找到更多上下文。