Bom dia.
Eu, assim como a maioria dos desenvolvedores que conheço, possuo uma certa dificuldade em escrever uma documentação relevante das classes e metodos que produzo.
Qual conteúdo que vocês acham relevantes de serem inseridos nos comentários de classes e métodos?
Vocês acham realmente necessário inserir comentários em todos os métodos, inclusive getters e setters que são óbvios? Por exemplo getNome(), getCPF(), etc.
Alguém tem uma “formula” para criar uma documentação interessante?
No site da MSDN, foi publicado um artigo interessante sobre documentação de API, os exemplos estão em C#, porém o que interessa realmente é o conteúdo dos comentários e não a sintaxe. Segue o link: http://msdn.microsoft.com/pt-br/magazine/gg309172.aspx
Abaixo criei uma classe simples e gostaria de ver com vocês fariam os comentários de métodos e classe para gerar uma boa documentação.
public class Matematica {
public int somar(int x, int y){
return x+y;
}
public int subtrair(int x, int y){
return x-y;
}
public int multiplicar(int x, int y){
return x * y;
}
}
Obrigado.