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

# Ausblenden von Code vor dem Compiler
Code kann vor dem Compiler verborgen werden, indem er auskommentiert wird.

**Code-Kommentare** sind Fragmente, die vom Compiler **nicht verarbeitet** werden.

Sie können Codezeilen mit den Symbolen `//` auskommentieren oder einen bestimmten Text- oder Codeabschnitt mit `/* */` einschließen.


### Warum benötigen wir Kommentare?

Kommentare sind Anmerkungen im Code, die vom Computer ignoriert werden, aber dazu dienen, zu erklären, was der Code macht. Sie erleichtern das Verständnis und die Wartung von Programmen und können auch verwendet werden, um Teile des Codes vorübergehend für Tests oder Debugging zu deaktivieren.



Im vorherigen Kapitel haben Sie ein Beispiel für das Kommentieren gesehen, bei dem ein Kommentar an der Stelle eingefügt wurde, an der der Code stehen sollte.

Hier ist ein weiteres Beispiel, wie Kommentare verwendet werden können:


cGFja2FnZSBjb20uZXhhbXBsZTsKCnB1YmxpYyBjbGFzcyBNYWluIHsKICAgIHB1YmxpYyBzdGF0aWMgdm9pZCBtYWluKFN0cmluZ1tdIGFyZ3MpIHsKICAgICAgICBTeXN0ZW0ub3V0LnByaW50bG4oIk1lc3NhZ2UgMSIpOwogICAgICAgIC8vIFN5c3RlbS5vdXQucHJpbnRsbigiTWVzc2FnZSAyIik7CgkgICAgU3lzdGVtLm91dC5wcmludGxuKCJNZXNzYWdlIDMiKTsKICAgIH0KfQ==

Hier werden nur die erste und dritte Nachricht angezeigt, da der zweite Teil auskommentiert ist und somit vom Compiler ignoriert wird.

Nun folgt ein Beispiel für das Kommentieren von **mehrzeiligem** Code:


cGFja2FnZSBjb20uZXhhbXBsZTsKCnB1YmxpYyBjbGFzcyBNYWluIHsKICAgIHB1YmxpYyBzdGF0aWMgdm9pZCBtYWluKFN0cmluZ1tdIGFyZ3MpIHsKICAgICAgICAvKiBTeXN0ZW0ub3V0LnByaW50bG4oIk1lc3NhZ2UgMSIpOwogICAgICAgIFN5c3RlbS5vdXQucHJpbnRsbigiTWVzc2FnZSAyIik7ICovCiAgICAgICAgU3lzdGVtLm91dC5wcmludGxuKCJNZXNzYWdlIDMiKTsKICAgIH0KfQ==

Wie Sie sehen, wird nur die dritte Nachricht in der Konsole angezeigt, da die erste und zweite auskommentiert sind.





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

Ein kompaktes Einsteiger-Modul, das sich auf die grundlegenden Java-Programmierkonzepte konzentriert: Syntax, Variablen, Datentypen, Kontrollstrukturen, Schleifen, Arrays und Strings.

Kommentare

Ausblenden von Code vor dem Compiler

Warum benötigen wir Kommentare?

Lösung