Почему иногда самый верхний комментарий в 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 */

Больше контекста можно найти в этой проблеме .