segunda-feira, 27 de julho de 2009

ASDoc - Documentando o seu código

Documentar o código é muito importante, não só para outros desenvolvedores que podem vir a olhar o seu código, mas também para você mesmo. Imagine você olhando um código complexo daqui a seis meses, por exemplo, só olhando o código você pode vir a precisar alguns preciosos minutos até se lembrar o que esta rotina faz, mas se tiver uma documentação, um comentário explicando, as coisas se tornam bem mais fáceis.

No java temos o JavaDoc e no Flex / AS3 temos o ASDoc.
Em vez de escrever mais sobre esta ferramenta vou indicar dois links muito bons sobre o assunto, são eles:
Este explica a sintaxe: Documentando código Flex (MXML e ActionScript)
Este como colocar usar em MXML: Adding ASDoc Comments to Flex MXML files

Nenhum comentário:

Postar um comentário