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

# Dölja kod för kompilatorn
Du kan dölja kod för kompilatorn genom att kommentera ut koden.

**Kodkommentarer** är fragment som kompilatorn **inte kommer att behandla**.

Du kan kommentera ut kodrader med hjälp av symbolerna `//` eller omsluta ett specifikt text- eller kodfragment med `/* */`.


### Varför behöver vi kommentarer?

Kommentarer är anteckningar i koden som ignoreras av datorn men hjälper till att förklara vad koden gör. De gör program enklare att förstå och underhålla, och kan även användas för att tillfälligt inaktivera delar av koden vid testning eller felsökning.



Du såg ett exempel på kommentering i föregående kapitel, där en kommentar placerades där koden skulle vara.

Här är ett annat exempel på hur man använder kommentarer:


cGFja2FnZSBjb20uZXhhbXBsZTsKCnB1YmxpYyBjbGFzcyBNYWluIHsKICAgIHB1YmxpYyBzdGF0aWMgdm9pZCBtYWluKFN0cmluZ1tdIGFyZ3MpIHsKICAgICAgICBTeXN0ZW0ub3V0LnByaW50bG4oIk1lc3NhZ2UgMSIpOwogICAgICAgIC8vIFN5c3RlbS5vdXQucHJpbnRsbigiTWVzc2FnZSAyIik7CgkgICAgU3lzdGVtLm91dC5wcmludGxuKCJNZXNzYWdlIDMiKTsKICAgIH0KfQ==

Endast det första och tredje meddelandet kommer att visas här eftersom den andra delen är kommenterad, vilket gör att kompilatorn ignorerar den.

Nu ska vi titta på ett exempel på **flerradig** kodkommentering:


cGFja2FnZSBjb20uZXhhbXBsZTsKCnB1YmxpYyBjbGFzcyBNYWluIHsKICAgIHB1YmxpYyBzdGF0aWMgdm9pZCBtYWluKFN0cmluZ1tdIGFyZ3MpIHsKICAgICAgICAvKiBTeXN0ZW0ub3V0LnByaW50bG4oIk1lc3NhZ2UgMSIpOwogICAgICAgIFN5c3RlbS5vdXQucHJpbnRsbigiTWVzc2FnZSAyIik7ICovCiAgICAgICAgU3lzdGVtLm91dC5wcmludGxuKCJNZXNzYWdlIDMiKTsKICAgIH0KfQ==

Som du kan se visas endast det tredje meddelandet i konsolen eftersom det första och andra är kommenterade.





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

En strömlinjeformad nybörjarmodul som fokuserar på de grundläggande Java-programmeringskoncepten: syntax, variabler, datatyper, kontrollflöde, loopar, arrayer och strängar.

Kommentarer

Dölja kod för kompilatorn

Varför behöver vi kommentarer?

Lösning