Tuto Documenter ses classes actionscript en quelques clics avec Flash, ActionScript

Dans cette formation, j'ai décidé de passer en revu la mise en place de documentation des classes ou de framework actionscript. Habituellement fastidieuse, cette étape est bien souvent mise de côté. C'est donc pour cette raison que j'ai décidé de vous prouver qu'il est possible de mettre en place une documentation efficace et professionnelle, sans pour autant passer par la douloureuse étape de l'envoi manuel de lignes de commandes.

En effet, je vais vous présenter un outil qui vous permettra d'automatiser au maximum ces taches répétitives. Nous passerons aussi en revu :les tags asdoc, étude de cas, etc.

Voici quelques unes des étapes passées en revue dans cette formation:

I°) Étude d'un framework

• Description
• Exemple avec code

Présentation des propriétés

• Présentation des méthodes
• Détail des propriétés et des méthodes

II°) Plus loin vers l'asdoc

• Mise à plat des tags les plus utilisés
• Explication depuis une documentation
• Étude de @parm, @private, etc

III°)Commenter correctement ses classe avant compilation de la doc

• Mise en place des tags header: @auteur, @date, etc
• Description de la classe
• Mise en place d'exemple de code listing
• Description de propriétés
• Empêcher la documentation de propriété
• Documenter des méthodes getter setter
• Documentation de méthodes et de leurs paramètres

IV Le flex SDK

• Téléchargement et installation
• Liaison du comilo asDoc pour la compilation externe

V°) Les réglages avant la compilation

• Réglages d'initialisation (colorisation, warning, génération xml,xls, frameset)
• Liaison avec le SDK de flex
• Liaison du framework action script et filtrage des classes
• Édition Main Title, Windows Title, Footer.

VI°)La compilation

• Génération du fichier asdoc
• Vérification du bon déroulement de la compilation depuis les lignes dos
• Récupération de la documentation

VII°)Les fichiers générés

• Possibilité d'édition des pages de documentations depuis les fichiers xml
• Possibilités de personnalisation de la documentation, exemple à l'appui

VIII°)Les bonnes adresses

• Visite guidée de quelques bonnes adresses concernant l'asdoc

IV°)Les fichiers sources:

• Classe de mon framework documentée (pour exemple)
• Raccourcis vers les sites incontournables liés à l'asdoc
• Documentation générée lors de cette formation (pack complet)