Question

Stack de grêle !!

Je développe un cadre pour mes collègues et j'ai du mal à le documenter.
Asdocs comme omettant les membres privés (même sans directive @private).

Existe-t-il un moyen de le forcer à le documenter ??

Était-ce utile?

La solution

Cela provient de la documentation ASDOCS:

Par défaut, l'outil ASDOC génère une sortie pour tous les éléments publics et protégés dans une classe ActionScript, même si vous omettez le commentaire ASDOC. Pour que Asdoc ignore un élément, insérez un commentaire ASDOC qui contient la balise @private n'importe où dans le commentaire. Le commentaire ASDOC peut contenir du texte supplémentaire avec la balise @private, qui est également exclue de la sortie.

Il dit explicitement "pour tous les éléments publics et protégés", ce qui a du sens pour la documentation de l'API: les membres privés ne sont pas accessibles à l'extérieur de la classe et restent donc cachés.

Voir cette réponse aussi: Documenter les membres privés avec ASDOC

Licencié sous: CC-BY-SA avec attribution
Non affilié à StackOverflow
scroll top