Как создать документацию для VAR-файлов только с помощью JSDoc?

Question

У меня есть файл javascript, который содержит множество глобальных переменных, которые комментируются, но JSDoc постоянно говорит: «Ничего не документировать, выход».

Вот пример:

/**
 * Name of the clients list
 * @type String
 * @final
 */
var CLIENTS_LIST_NAME = "Client";

Есть ли способ создания документации для такого файла .js?

Answer 1

Похоже, вы используете мой старый проект на основе Perl с именем JSDoc.pm. Я бы порекомендовал вам перейти на мой новый проект под названием JsDoc Toolkit. Синтаксис нового проекта в основном является расширенным набором тегов, используемых в более старом проекте, но посмотрите на вики проекта JsDoc Toolkit для получения полного списка всех поддерживаемых тегов.

В JsDoc Toolkit будет работать следующее:

/**
 * Name of the clients list
 * @type String
 * @constant
 */
var CLIENTS_LIST_NAME = "Client";