Documentando seu código ActionScript 2.0

Hoje em dia, documentar o código faz parte de nossas vidas. Quando somos clientes a exigimos, quando somos fornecedores temos que entregá-la, pois é parte integrante do projeto. E mesmo que ninguém nos exigisse, sabemos que é extremamente importante documentar nosso código.

Há um tempo atraz me vi com esse problema com ActionScript 2.0 e comecei a pesquisar algumas ferramentas na Internet. Achei algumas:

• Doxygen;
• JSDoc;
• AS2Doc;
• BLDoc;

A Doxygen é bem completa e permite várias customizações, mas não gostei do html gerado.

O JSDoc é um docuementador de JavaScript e até existe uma adapatação para AS, mas encontrei diversos bugs e não usei.

O AS2Doc talvez seja o mais famoso. É uma ótima alternativa paga.

A que mais me agradou foi a BLDoc, pela documentação ser idêntica ao JavaDoc e pelo código html gerado. Também, porque é a mais simples e fácil de usar, basta executar o arquivo salvo novamente para ele recriar toda documentação. Também, ela foi feita para AS2, ou seja, tem funcionalidades como documentar Eventos ([Event (“myevent”)]) e métodos get e set implícitos. A documentação também pode ser gerada em Flash.

Coloquei alguns exemplos de documentação com o BLDoc. Coloquei os arquivos AS a e documentação gerada que se encontra na pasta docs. Basta abrir o arquivo index.html.