03-Documentação-Identação.md

Documentação e indentação

A documentação é uma parte importante de um código pois cada pessoa tem uma maneira diferente de se programar, e quando outro programador ler seu código, ele irá entender mais facilmente o que está acontecendo. A indentação é uma parte importante deste processo, ela é a maneira como se dispõe seu código. Nenhuma delas é necessária para o código funcionar, mas é uma boa prática realizá-las.

Documentação

Para documentar ou comentar um código é bem simples, digita-se duas barras ( // ) para uma linha ou ( /**/ ) para comentar múltiplas linhas. Abaixo contém um código de exemplo.

public class Documentacao {
    public static void main(String args[]) {
        System.out.println("A soma de 2+2 é igual a 4");
        //Essa linha mostra no console a soma de 2+2.
        /* O programa 
        exibirá uma
        mensagem
        */
    }
}

Nenhuma linha que está a frente das duas barras ( // ) é interpretada pelo compilador, é somente vista pelo humano que está lendo seu código.

Obs.: O comentário de várias linhas é mais utilizado para documentar o que o método faz.

Indentação

Para manter uma boa leitura do código é necessário uma indentação, que ao longo de suas práticas vai se tornando mais fácil de se utilizar. Para você perceber a diferença entre um código indentado ou não, vai abaixo os dois exemplos.

Código não indentado:

public class Indentacao1{
public static void main(String args[]){
System.out.println("Olá");
System.out.println("Olá");
System.out.println("Olá");
}
}

A medida em que o código cresce, fica difícil de se enxergar o que está acontecendo, uma coisa fica embolada na outra.

Código indentado:

public class Indentacao2 {
    public static void main(String args[]) {
        System.out.println("Olá");
        System.out.println("Olá");
        System.out.println("Olá");
    }
}

Aos olhos humanos fica mais fácil de se entender e enxergar. Para o compilador em alguns casos não irá fazer diferença, mas até para você que está programando fica melhor de se organizar.

Próximo - Variáveis