12 de outubro de 2017
De acordo com a Code Conventions da Oracle (2016), é importante colocar comentários ao longo do desenvolvimento do código que servirão como uma documentação de consulta para futuras manutenções. Quanto maior um código, maior é a necessidade de sua documentação para ser mais fácil encontrar um método específico, por exemplo.

Quando um bloco com um comentário inicial for inserido, é necessário separar a última linha do código anterior e o comentário com uma linha em branco. O comentário é sempre referente ao código que segue.

public class Comentario {
   
    String a;
    String b = "Como comentar um código.";
   
    //Método que mostra uma mensagem
    public void mostrarMensagem(){
        ...
        if(a == b){
            System.out.println(b);
        }           
    }
}

No código acima podemos verificar a inserção correta de um comentário. Existe uma linha em branco entre o comentário e a última linha de código acima dele. Além disso, o comentário se refere ao método que inicia logo abaixo dele.

Referência:

ORACLE. Code Conventions for the Java Programming Language: Contents, 2016. Disponível em: <http://www.oracle.com/technetwork/java/codeconvtoc-136057.html>. Acesso em: 23 jan.2016

0 comentários:

Postar um comentário

Comentários:

Perfil

Formada em Sistemas de Informação e pós-graduada em Engenharia de Software.

Facebook

Views