O poder da documentação

Utilizando a documentação de códigos fontes ao seu favor

Transcript

1. O poder da documentação do código-fonte
2. ✔Graduando em Análise e Des. de Sistemas pela Maurício de Nassau ✔Desenvolvedor web a 10 anos ✔Membro do grupo PHP-PB ✔Apaixonado por Linux ✔Amante do N!MOC Victor Feitoza
3. Por que documentar?
4. Padrão a ser adotado?
5. JavaDoc
6. Comentários especiais ✔Possuem o formato /** ... */ ✔Se referem ao próximo identificador sendo definido (classe, método, atributo, etc.) ✔A primeira frase do comentário é utilizada como uma descrição resumida do elemento ✔O conteúdo do comentário é composto por dois blocos: descrição HTML e marcas especiais
7. Uso de marcas ✔Marcas especiais podem ser utilizadas na documentação de aplicações, pacotes, classes, interfaces, construtores, métodos e atributos, após a descrição ✔Para os diferentes elementos, diferentes conjuntos de marcas estão disponíveis
8. Marcas especiais ✔A descrição HTML termina quando é encontrada uma linha iniciada por uma marca especial na forma @<marca>, desconsiderando-se espaços e asterísticos iniciais ✔Uma marca especial também pode ter a forma {@<marca> <parâmetros>}
9. Finalidades das marcas ✔Documentam assinaturas de métodos ✔Fazem referências cruzadas ✔Sinalizam código depreciado ✔E outras...
10. Comentários gerais Comentários de classes e interfaces Comentários de métodos
11. Comentários gerais ✔@since ✔@version ✔@see
12. Comentários de classes e interfaces ✔@author ✔@version
13. Comentários de métodos ✔@param ✔@return ✔@throws
14. Comentários de métodos ✔@param ✔@return ✔@throws
15. DÚVIDAS
16. http://vfeitoza.com.br vfeitoza@gmail.com @vfeitoza