Summary  
This chapter covers using single-line (//) and multi-line (/* */) comments to annotate code and temporarily disable portions of it without affecting program execution.

General domain of usage  
Code documentation

# Ocultando Código do Compilador
É possível ocultar código do compilador comentando o código.

**Comentários de código** são trechos que o compilador **não processa**.

É possível comentar linhas de código utilizando os símbolos `//` ou envolver um trecho específico de texto ou código usando `/* */`.


### Por que Precisamos de Comentários?

Comentários são anotações no código que são ignoradas pelo computador, mas ajudam a explicar o que o código faz. Facilitam a compreensão e manutenção dos programas, além de poderem ser utilizados para desabilitar temporariamente partes do código para testes ou depuração.



Você viu um exemplo de comentário no capítulo anterior, onde um comentário foi colocado no local onde o código deveria estar.

Veja outro exemplo de como utilizar comentários:


cGFja2FnZSBjb20uZXhhbXBsZTsKCnB1YmxpYyBjbGFzcyBNYWluIHsKICAgIHB1YmxpYyBzdGF0aWMgdm9pZCBtYWluKFN0cmluZ1tdIGFyZ3MpIHsKICAgICAgICBTeXN0ZW0ub3V0LnByaW50bG4oIk1lc3NhZ2UgMSIpOwogICAgICAgIC8vIFN5c3RlbS5vdXQucHJpbnRsbigiTWVzc2FnZSAyIik7CgkgICAgU3lzdGVtLm91dC5wcmludGxuKCJNZXNzYWdlIDMiKTsKICAgIH0KfQ==

Apenas a primeira e a terceira mensagens serão exibidas aqui porque a segunda parte está comentada, então o compilador a ignora.

Agora, observe um exemplo de comentário de código em **múltiplas linhas**:


cGFja2FnZSBjb20uZXhhbXBsZTsKCnB1YmxpYyBjbGFzcyBNYWluIHsKICAgIHB1YmxpYyBzdGF0aWMgdm9pZCBtYWluKFN0cmluZ1tdIGFyZ3MpIHsKICAgICAgICAvKiBTeXN0ZW0ub3V0LnByaW50bG4oIk1lc3NhZ2UgMSIpOwogICAgICAgIFN5c3RlbS5vdXQucHJpbnRsbigiTWVzc2FnZSAyIik7ICovCiAgICAgICAgU3lzdGVtLm91dC5wcmludGxuKCJNZXNzYWdlIDMiKTsKICAgIH0KfQ==

Como pode ser observado, apenas a terceira mensagem é exibida no console porque a primeira e a segunda estão comentadas.





import static org.junit.jupiter.api.Assertions.assertTrue;

import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.PrintStream;
import java.nio.file.Files;
import java.nio.file.Paths;
import java.util.regex.Pattern;

import com.example.Main;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;

public class MainTest {

    @Test
    @DisplayName("The code prints the right message")
    void testPrintsHelloWorldFlexible() {
        ByteArrayOutputStream outContent = new ByteArrayOutputStream();
        PrintStream originalOut = System.out;
        System.setOut(new PrintStream(outContent));

        Main.main(new String[]{});

        System.setOut(originalOut);

        String output = outContent.toString().trim();

        Pattern pattern = Pattern.compile("Hey\\\s+I'm\\\s+working", Pattern.CASE_INSENSITIVE);
        assertTrue(pattern.matcher(output).find(), "Actual output: " + output);
    }

    @Test
    @DisplayName("Comment was used to ignore the line with mistake.")
    public void testContainsCommentToRemoveThirdLine() throws IOException {
        String path = "/app/devResources/java/src/main/java/com/example/Main.java";
        String content = new String(Files.readAllBytes(Paths.get(path)));

        String[] lines = content.split("\\\R");
        String normalizedContent = content.replaceAll("\\\s+", "");

        boolean foundAsComment = normalizedContent.contains("//System.out.println");

        assertTrue(foundAsComment);
    }
}

MainTest.java

Um módulo introdutório simplificado focado nos conceitos essenciais de programação em Java: sintaxe, variáveis, tipos de dados, controle de fluxo, laços, arrays e strings.

Comentários

Ocultando Código do Compilador

Por que Precisamos de Comentários?

Solução