Comment écrire un commentaire pour un article que j'ai défini dans flex?

Question

Je souhaite ajouter un commentaire à certains éléments d'un document Flex et traiter les commentaires à l'aide d'ASDoc. Je peux facilement le faire pour la partie script, mais je me retrouve avec une tonne de laid "Cette propriété peut être utilisée comme source pour la liaison de données." messages pour chaque élément que j'ai déclaré dans Flex.

Y a-t-il un moyen d'incorporer un commentaire dans un élément flex afin qu'il puisse être lu par ASDoc? Je l'ai essayé d'utiliser la notation standard

<!-- --> 

, mais cela ne semble pas fonctionner.

EDIT: La notation semble être engloutie comme un commentaire HTML, je suppose que vous savez à quoi il ressemble ...

Answer 1

Êtes-vous essayer de mettre des commentaires dans le balisage? Selon la documentation Flex here, "Étant donné que le format d'un commentaire ASDoc utilise la syntaxe ActionScript, vous ne pouvez insérer qu'un commentaire ASDoc dans un bloc d'un fichier MXML."

Answer 2

Sans voir votre code, il est un peu difficile de dire exactement ce qui se passe. Rien sur ASdocs ne devrait générer une erreur de compilateur liable. Obtenez-vous cette erreur à partir du compilateur Flex ou du compilateur ASDoc? Essayez-vous de documenter un document MXML ou un document ActionScript?

Avez-vous lu ces documents?

Sur ActionScript:

/** 
* Your Comment Goes Here 
*/ 
ActionScript Element 

Et MXML? Les commentaires MXML ASDoc doivent utiliser trois tirets, pas deux pour le premier marqueur de commentaire. Comme ceci:

<!--- Your comment goes here --> 
MXML Element 

Answer 3

Vous pouvez utiliser ces // et/* */(dans les blocs ActionScript) Pour commenter un nœud MXML utilisation <!-- and end with -->