Documentation de code ActionScript 2
Par -Alexandre LEGOUT aka LAlex- le mardi, janvier 6 2004, 10:00 - Projets - Lien permanent
Lorsque j'ai présenté mon parseur AS2, kalysto a lancé l'idée de créer un format de documentation du code, sur la base de JavaDoc. L'idée n'est pas forcément neuve, et Grant Skinner dans son application gModeler (application de diagrammes UML en Flash) à déjà initié ce type de commentaires. ![]()
Seulement, le format FlashDoc a pour inconvénient de ne pas être libre de droits, et qui plus est dédié à l'AS1. :? Commenter des classes AS1 nécessite de préciser dans la documentation les types de variables, noms de classe, etc... Ce qui n'est plus nécessaire avec l'A2, étant donné que le typage fort, la déclaration de classes et la répartition du code par fichier donnent déjà un grand nombre d'informations.
Nous travaillons donc ensemble à l'élaboration d'un tel format de commentaires, trés proche de JavaDoc, ainsi qu'un parseur qui pourra générer un document XML a partir du code AS, qui lui-même pourra ensuite être mis en page par une feuille de style XSL ... Pour la peine, je suis en train de redévelopper complètement mon parseur AS2, avec deux aspects : un aspect analyse du code (classe, dépendances, méthodes, propriétés) et un autre aspect servant à la colorisation et à la mise en forme du code (blocs d'instructions, chaine de caractères, commentaires, etc...)
J'ai ensuite l'intention de créer un outil basé sur le parseur, qui permettra d'aider à la documentation du code ... Le format XML aidant, cet outil pourra être en PHP et en Flash ! ![]()
Les premiers résultats de ces travaux devraient être disponibles dans pas trop longtemps ... ![]()
Commentaires
Juste aprés avoir posté ce message, je suis tombé sur un projet similaire, mais offline (en .NET) : http://www.rewindlife.com/archives/000124.cfm :oops:
L'idéal serait que ces deux applications partagent le même format XML intermédiaire ...
A suivre ...
bonne chance, le projet est carrement interessant!
Samuel R. Neff (développeur du logiciel C# sus-cité) m'a communiqué les specs de son format XML, ainsi que celles des commentaires tels qu'ils seront parsés par son application. Kalysto et moi allons certainement faire en sorte que le parseur online soit compatible avec l'application en C# ...
Si plusieurs applications utilisent le même format, c'est peut-être un premier pas vers un standard ? :o Avant d'en arriver la, on va deja essayer de faire tourner tout ca !

Je ne sais pas si tu connais le petit editeur UMLet qui permet de modelliser des relations de classes au format UML mais les fichiers de descriptions lu par UMLet sont de simples fichiers XML.
Si tu crée un parseur pour générer la doc, ca semble jouable de créer en même temps un fichier xml lisible par UMLet, ca offrirait du même coup une représentation graphique des classes
tu en sais un peu plus sur ce format XML ?
c koi son nom ? XMI ? si c ca, c lion d'etre un format tout simple :'(
et pis, rien nous empeche de faire une seconde feuille xsl qui transforme le 1er XML disons standard en 2eme XML qui peut etre afcihée graphiquement ...
pour l'instant, on attend les specs completes du format XML du truc C#
Depuis le 6 janvier 2004 y a pas de nouvelle de ce ActionScriptDoc ??
Fil des commentaires de ce billet