Rust-Kommentare
Das Kommentieren in Rust unterstützt, wie in anderen Sprachen (C, Java), zwei Kommentarstile:
Beispiel
// Dies ist der erste Kommentarstil
/* Dies ist der zweite Kommentarstil */
/*
* Mehrzeiliger Kommentar
* Mehrzeiliger Kommentar
* Mehrzeiliger Kommentar
*/
/* Dies ist der zweite Kommentarstil */
/*
* Mehrzeiliger Kommentar
* Mehrzeiliger Kommentar
* Mehrzeiliger Kommentar
*/
Dokumentationskommentare
In Rust wird durch//der Inhalt danach bis zum ersten Zeilenumbruch zu einem Kommentar.
Nach dieser Regel sind drei Schrägstriche///weiterhin ein gültiger Kommentaranfang. Daher kann Rust///als Beginn von Dokumentationskommentaren verwenden:
Beispiel
/// Fügt eins zu der angegebenen Zahl hinzu.
///
/// # Beispiele
///
/// ```
/// let x = add(1, 2);
///
/// ```
fn add(a: i32, b: i32) -> i32 {
return a + b;
}
fn main() {
println!("{}",add(2,3));
}
///
/// # Beispiele
///
/// ```
/// let x = add(1, 2);
///
/// ```
fn add(a: i32, b: i32) -> i32 {
return a + b;
}
fn main() {
println!("{}",add(2,3));
}
Die Funktion add im Programm hat dann einen eleganten Kommentar, und er kann in der IDE angezeigt werden:
Tipp：Cargo verfügt über die Funktionalität cargo doc. Entwickler können diesen Befehl verwenden, um die Dokumentationskommentare im Projekt in Dokumentation im HTML-Format umzuwandeln.
Andere Erweiterungen