Kommentar

Hinweis

Wenn Sie bereits C, C++, Java oder C# gelernt haben, können Sie diese Lektion überspringen. Der Grund: Die Kommentare in Rust funktionieren nahezu identisch wie in diesen Sprachen.

Was ist ein Kommentar?

Ein erläuternder Text für Menschen, der vom Compiler ignoriert wird und nicht am Programmablauf beteiligt ist.

Welche Aufgaben haben Kommentare?

• Erklären der Code-Funktionalität: Für Menschen geschrieben, um den Code verständlicher zu machen
• Hinterlegen von Erstellungsinformationen: Zum Generieren von Dokumentationen genutzt
• Temporäres Ausblenden von Code: Code nicht löschen, aber vor der Ausführung blockieren durch Kommentare
• Erhöhen der Lesbarkeit des Codes

Zwei / drei Kommentararten in Rust

• Einzeiliger Kommentar: Beginnt mit // und reicht bis zum Zeilenende
• Blockkommentar: Kann mehrere Code-Zeilen umschließen, Syntax über mehrere Zeilen hinweg nutzbar /* ... */

Kommentare ähneln den Notizen, die Sie beim Lernen in Ihr Lehrbuch schreiben, um den Inhalt besser zu verstehen.

Zuerst lernen wir die zwei gängigen Kommentararten, die dritte Form behandeln wir später.

fn main() {
    // Ein einzeiliger Kommentar beginnt mit zwei Schrägstrichen und endet am Zeilenende.
    // Alles nach den Schrägstrichen in dieser Zeile wird vom Compiler ignoriert.

    // Beispiel: Diese Code-Zeile wird nicht ausgeführt
    // println!("Hello, world!");

    // Versuchen Sie, die oberen Schrägstriche zu entfernen und den Code erneut auszuführen.

    /*
     * Blockkommentare eignen sich zum vorläufigen Deaktivieren von Code, siehe unten
     * Sie unterstützen zudem Verschachtelung: /* so wie hier */, um große Codeblöcke schnell auszukommentieren.
     */

    /*
     * println!("Hello, world!");
     * println!("Hello, world2!");
     */

    /*
    Hinweis: Die Sternchen in der linken Spalte dienen nur der optischen Formatierung,
    sie sind keine Pflichtbestandteil der Sprachsyntax und können weggelassen werden.
    */

    // Mit einem zusätzlichen Schrägstrich lassen sich Blockkommentare schnell aktivieren/deaktivieren:

    /* <- Fügen Sie hier einen weiteren Schrägstrich hinzu, um den gesamten unteren Blockkommentar aufzuheben (schreiben Sie / vor /* → //*, probieren Sie es aus)
    
    println!("Jetzt");
    println!("Aller");
    println!("Code wird ausgeführt!");
    // Einzeilige Kommentare im Inneren bleiben unberührt

    // */

    // Blockkommentare können auch mitten in einem Ausdruck platziert werden:
    let x = 5 + /* 90 + */ 5;
    println!("`x` ist 10 oder 100? x = {}", x);
}Code-Sprache: PHP (php)

Kopieren Sie den obigen Code und testen Sie ihn selbst, insbesondere den Teil „/* <- Fügen Sie hier einen weiteren Schrägstrich hinzu, um den gesamten unteren Blockkommentar aufzuheben“

(Erläuterung: Wenn Sie ein / vor /* schreiben, entsteht //* – der Startmarker des Blockkommentars wird ungültig, und das folgende // */ wird wiederum als einzeiliger Kommentar gewertet.)

Damit wird der Blockkommentar vorläufig entfernt, und die dazwischenliegenden println-Anweisungen werden ausgeführt.

Dokumentationskommentare

Dokumentationskommentare können mit speziellen Werkzeugen zu HTML-Dokumenten umgewandelt werden, um Entwicklern das Nachschlagen zu erleichtern. Dies behandeln wir in einer separaten Folgelektion.