Rust Kommentartypen und Dokumentation

Einführung

In diesem Lab lernen wir über die verschiedenen Arten von Kommentaren, die von Rust unterstützt werden, einschließlich regulärer Kommentare und Dok-Kommentare. Reguläre Kommentare können Zeilenkommentare sein, die mit zwei Schrägstrichen beginnen und bis zum Ende der Zeile gehen, oder Blockkommentare, die zwischen /* und */ eingeschlossen sind und geschachtelt werden können. Dok-Kommentare hingegen werden verwendet, um HTML-Bibliothekdokumentation zu generieren und beginnen mit /// oder //!.

Hinweis: Wenn das Lab keinen Dateinamen angibt, können Sie einen beliebigen Dateinamen verwenden. Beispielsweise können Sie main.rs verwenden, es mit rustc main.rs &&./main kompilieren und ausführen.

Kommentare

Jedes Programm erfordert Kommentare, und Rust unterstützt einige verschiedene Arten:

• Reguläre Kommentare, die vom Compiler ignoriert werden:
  • // Zeilenkommentare, die bis zum Ende der Zeile gehen.
  • /* Blockkommentare, die bis zum schließenden Trennzeichen gehen. */
• Dok-Kommentare, die in HTML-Bibliothekdokumentation analysiert werden:
  • /// Generiere Bibliothekdokumentation für das folgende Element.
  • //! Generiere Bibliothekdokumentation für das umgebende Element.

fn main() {
    // Dies ist ein Beispiel für einen Zeilenkommentar.
    // Es gibt zwei Schrägstriche am Anfang der Zeile.
    // Und nichts, was nach diesen geschrieben wird, wird vom Compiler gelesen.

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

    // Führe es aus. Siehe? Versuche jetzt, die beiden Schrägstriche zu löschen und es erneut auszuführen.

    /*
     * Dies ist ein anderer Typ von Kommentar, ein Blockkommentar. Im Allgemeinen
     * werden Zeilenkommentare als empfohlene Kommentarstil angesehen. Aber Blockkommentare
     * sind extrem nützlich, um Teile des Codes vorübergehend zu deaktivieren.
     * /* Blockkommentare können /* geschachtelt */ */ werden, sodass es nur wenige
     * Tastatureingaben benötigt, um alles in dieser main()-Funktion auszukommentieren.
     * /*/*/* Probieren Sie es selbst aus! */*/*/
     */

    /*
    Hinweis: Die vorherige Spalte von `*` war ausschließlich für den Stil. Es besteht
    keine tatsächliche Notwendigkeit dafür.
    */

    // Sie können Ausdrücke leichter mit Blockkommentaren manipulieren
    // als mit Zeilenkommentaren. Versuchen Sie, die Kommentartrennzeichen zu löschen,
    // um das Ergebnis zu ändern:
    let x = 5 + /* 90 + */ 5;
    println!("Ist `x` 10 oder 100? x = {}", x);
}

Zusammenfassung

Herzlichen Glückwunsch! Sie haben das Kommentare-Lab abgeschlossen. Sie können in LabEx weitere Labs ausprobieren, um Ihre Fähigkeiten zu verbessern.