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

# Koodin piilottaminen kääntäjältä
Voit piilottaa koodia kääntäjältä kommentoimalla sen.

**Koodikommentit** ovat osia, joita kääntäjä **ei käsittele**.

Voit kommentoida koodirivejä käyttämällä `//`-merkkejä tai ympäröidä tietyn tekstin tai koodin osan `/* */`-merkeillä.


### Miksi tarvitsemme kommentteja?

Kommentit ovat koodissa olevia huomautuksia, jotka tietokone ohittaa, mutta jotka auttavat selittämään, mitä koodi tekee. Ne tekevät ohjelmista helpommin ymmärrettäviä ja ylläpidettäviä, ja niitä voidaan käyttää myös tilapäisesti poistamaan osia koodista testauksen tai virheenkorjauksen ajaksi.



Näet esimerkin kommentoinnista edellisessä luvussa, jossa kommentti sijoitettiin kohtaan, johon koodin oli tarkoitus tulla.

Tässä on toinen esimerkki kommenttien käytöstä:


cGFja2FnZSBjb20uZXhhbXBsZTsKCnB1YmxpYyBjbGFzcyBNYWluIHsKICAgIHB1YmxpYyBzdGF0aWMgdm9pZCBtYWluKFN0cmluZ1tdIGFyZ3MpIHsKICAgICAgICBTeXN0ZW0ub3V0LnByaW50bG4oIk1lc3NhZ2UgMSIpOwogICAgICAgIC8vIFN5c3RlbS5vdXQucHJpbnRsbigiTWVzc2FnZSAyIik7CgkgICAgU3lzdGVtLm91dC5wcmludGxuKCJNZXNzYWdlIDMiKTsKICAgIH0KfQ==

Vain ensimmäinen ja kolmas viesti näytetään tässä, koska toinen osa on kommentoitu, joten kääntäjä ohittaa sen.

Tarkastellaan nyt esimerkkiä **monirivisestä** koodin kommentoinnista:


cGFja2FnZSBjb20uZXhhbXBsZTsKCnB1YmxpYyBjbGFzcyBNYWluIHsKICAgIHB1YmxpYyBzdGF0aWMgdm9pZCBtYWluKFN0cmluZ1tdIGFyZ3MpIHsKICAgICAgICAvKiBTeXN0ZW0ub3V0LnByaW50bG4oIk1lc3NhZ2UgMSIpOwogICAgICAgIFN5c3RlbS5vdXQucHJpbnRsbigiTWVzc2FnZSAyIik7ICovCiAgICAgICAgU3lzdGVtLm91dC5wcmludGxuKCJNZXNzYWdlIDMiKTsKICAgIH0KfQ==

Kuten huomaat, vain kolmas viesti näkyy konsolissa, koska ensimmäinen ja toinen on kommentoitu pois.





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

Tiivis aloitusmoduuli, joka keskittyy Java-ohjelmoinnin keskeisiin peruskäsitteisiin: syntaksi, muuttujat, tietotyypit, ohjausrakenteet, silmukat, taulukot ja merkkijonot.

Kommentit

Koodin piilottaminen kääntäjältä

Miksi tarvitsemme kommentteja?

Ratkaisu