Comentários e Delimitadores em Java

Comente seus códigos, deixe-os bem explicados e claros para quando outros programadores forem ler.

Daqui alguns meses, quando estiver mais avançado em nosso curso de Java, você vai notar que esses 'outros' incluem você, quando não se lembrar mais o motivo de ter implementado o método daquele jeito.

Um comentário é sempre bom para explicar o que um trecho no seu código significa, assim você ou outra pessoa não perde tempo tentando decifrar.

Basta ler o comentário que explica seu funcionamento.

• Download da Apostila Java Progressivo

Como fazer comentários nos códigos Java

Bom, nessa altura do campeonato você já deve ter criado vários projetos e saídas.

Crie um projeto chamado 'Teste'.

Vamos testar uma coisa, vamos colocar essa linha aqui embaixo da 'main' e ver o que acontece:
//Olá, o que acontece se eu escrever isso?

Teste:

public class Teste {

    //Olá, o que acontece se eu escrever isso?
    public static void main(String[] args) {
        System.out.println("Não sei! O que acontece se escrever aquilo lá?");
    }
}

O que fizemos foi um comentário.
Tudo o que colocarmos na mesma linha e depois das duas barras, '//', não surtirá efeito na compilação/execução. Você pode até xingar o Java que ele vai rodar do mesmo jeito.

Pra que ser isso então, se não vai influenciar em nada?

Bom, em grandes projetos, principalmente os acadêmicos e os que envolvem complexa lógica, fica complicado entender o que outro programador programou.
As vezes parecem hieróglifos.
As vezes o sujeito faz uma magia matemática e você não consegue entender o que ele fez.
As vezes você cria um algoritmo complexo e longo, passa meses sem mexer nesse código e depois quando vai olhar de volta não consegue se lembrar como criou aquilo.


Os comentários servem para isso, escreva algo do tipo, antes:
//o seguinte método faz isso, isso e aquilo
//essa classe é usada pra aqueles
//esse algoritmo recebe esses números, faz esses cálculos e retorna essa operação

Porém, evite comentar tudo. Não comente o óbvio:
//me sentei
//pausa pra ler o globo.com
//a função exibe 'Bom dia' na tela

Use comentários para coisas que não entende, como coisas bizarras, por exemplo:
//A saída simples a seguir é uma famosa música sertaneja universitária brasileira, de 2012
System.out.println("Tchê tchê-rê-rê tchê-tchê tchê tchê tchê");

PS: Caso você saiba o que isso significa, por favor, me avise.

Como usar os delimitadores /* */ em Java

Vamos supor que você vai criar um algoritmo complexo, ou copiou uma questão na IDE mesmo (pra não ter que ficar olhando pro livro, pro Java Progressivo ou pro pdf).
Supondo que esse comentário tenha vária linhas, dezenas. E aí?
Vai criar dezenas de '//' ?
// Questão 08
// do site: Java Progressivo
// sobre Saídas Simples
// do curso de Java
// desenhe a letra P de forma gigante com os caracteres P



Claro que não, isso é muito cansativo.
Pra isso, existem os delimitadores '/*' e '*/'
Tudo o que você escrever dentro dele será desconsiderado. Veja:

/* Cavalo de Fogo
No meu sonho eu já vivi
Um lindo conto infantil

Tudo era magia,
Era um mundo fora do meu
E ao chegar desse sono acordei

Foi quando correndo eu vi
Um cavalo de fogo alí
Que tocou meu coração
Quando me disse, então
Que um dia rainha eu seria
Se com a maldade pudesse acabar
No mundo dos sonhos pudesse chegar */


public class Teste {

    public static void main(String[] args) {
        System.out.println("Tenho saudades dos desenhos da minha infância");
    }
}

Note que o NetBeans já realça em uma cor diferente a parte que será delimitada, que é um comentário.