Dans la précédente version de Flex Builder (3), l'AsDoc était complètement ignorée. Vous pouviez, certes, en écrire mais à part pour relecture, cela n'apparaissait jamais pour vous aider.
Pour ceux qui ne connaissent pas, l'AsDoc est l'équivalent de la JavaDoc pour ActionScript, permettant d'annoter sa classe afin de produire une documentation complète (au format HTML par exemple). Inutile de préciser que la documentation de son code est un élément indispensable pour les développeurs.
Avec Flash Builder 4 vient l'arrivée de la prise en compte de ces tags AsDoc avec affichage dans l'interface ou dans une vue Eclipse dédiée.
Ecriture de documentation au format AsDoc
Pour écrire des commentaires en AsDoc, il suffit de suivre des conventions de nommage. Des plugins comme FlexFormatter peuvent vous aider à pré-générer cette documentation.
Au lieu de vous énoncer des règles qui sont déjà écrites, voici un lien vers un article très complet de FlashXpress:
Commenter ses Classes AS3 au format ASDoc
Voilà, à partir de maintenant, on va considérer que vous savez écrire votre documentation 
.
Quelques précisions…
Vous pourrez aussi visualiser la documentation des librairies SWC (si elles contiennent de l'AsDoc bien sûr). C'est d'ailleurs comme cela que vous avez accès à toute la documentation du framework Flex
Notez que Flash Builder 4 ne vous permet toujours pas d'exporter votre AsDoc au format HTML facilement. Cependant, comme avec Flex Builder 3, vous pouvez utiliser l'outil asdoc.exe présent dans le dossier "bin" du framework. Couplé avec un petit script Ant ou une petite Debug Configuration dans Eclipse, vous pourrez générer facilement la documentation de votre projet.
Voici quelques articles pour vous mettre sur la voie:
- http://knomedia.com/blog/2009/11/05/creating-asdocs-in-flash-builder/
- http://www.peterelst.com/blog/2009/06/08/flash-builder-4-beta-exporting-asdoc-documentation/
Sinon il y a le très bon outil AsDocr de Grant Skinner permettant de configurer plus finement l'export de son AsDoc. On obtient la ligne de commande à exécuter et voilà.
L'AsDoc dans l'auto-complétion
Premier exemple d'utilisation de AsDoc dans Flash Builder 4, l'auto-complétion (Ctrl+Espace):
L'AsDoc au rollover
La documentation apparait aussi au survol d'une propriété / fonction / type comme ceci:
Lire la suite: 'Flash Builder 4 – Gestion de l'AsDoc (documentation)'
Commentaires récents