ASDocs пропускает частных членов

Славься!

Я разрабатываю основу для своих коллег, и у меня возникают проблемы с ее документированием.
ASDocs опускает закрытые члены (даже без директивы @private).

Есть ли способ заставить его документировать это?

Источник

1 ответ

Решение

Это из документации ASDocs:

По умолчанию инструмент ASDoc создает выходные данные для всех открытых и защищенных элементов в классе ActionScript, даже если вы опускаете комментарий ASDoc. Чтобы ASDoc игнорировал элемент, вставьте комментарий ASDoc, который содержит тег @private, в любое место комментария. Комментарий ASDoc может содержать дополнительный текст вместе с тегом @private, который также исключается из вывода.

В нем явно сказано "для всех открытых и защищенных элементов", что имеет смысл для документации API: закрытые члены не доступны извне класса и поэтому остаются скрытыми.

См. Также этот ответ: Документирование частных членов с ASDoc

Источник
Другие вопросы по тегам