O poder da documentao do cdigo-fonte

Graduando em Anlise e Des. de Sistemas pela Maurcio de Nassau

Desenvolvedor web a 10 anos Membro do grupo PHP-PB Apaixonado por Linux Amante do N!MOC

Victor Feitoza

Por que documentar?

Padro a ser adotado?

JavaDoc

Comentrios especiais Possuem o formato /** ... */ Se referem ao prximo identificador sendo definido (classe, mtodo, atributo, etc.) A primeira frase do comentrio utilizada como uma descrio resumida do elemento O contedo do comentrio composto por dois blocos: descrio HTML e marcas especiais

Uso de marcas Marcas especiais podem ser utilizadas na documentao de aplicaes, pacotes, classes, interfaces, construtores, mtodos e atributos, aps a descrio Para os diferentes elementos, diferentes conjuntos de marcas esto disponveis

Marcas especiais A descrio HTML termina quando encontrada uma linha iniciada por uma marca especial na forma @<marca>, desconsiderando-se espaos e astersticos iniciais Uma marca especial tambm pode ter a forma {@<marca> <parmetros>}

Finalidades das marcas Documentam assinaturas de mtodos Fazem referncias cruzadas Sinalizam cdigo depreciado E outras...

Comentrios gerais Comentrios de classes e interfaces Comentrios de mtodos

Comentrios gerais @since @version @see

Comentrios de classes e interfaces @author @version

Comentrios de mtodos @param @return @throws

Comentrios de mtodos @param @return @throws

DVIDAS

http://vfeitoza.com.br vfeitoza@gmail.com @vfeitoza