ASDocs пропускает частных членов - PullRequest
1 голос
/ 16 февраля 2011

Hail Stack !!

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

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

1 Ответ

3 голосов
/ 16 февраля 2011

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

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

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

См. также этот ответ: Документирование закрытых членов с помощью ASDoc

...