English | 简体中文 | 繁體中文 | Русский язык | Français | Español | Português | Deutsch | 日本語 | 한국어 | Italiano | بالعربية

Rust 注释

Die Arten der Kommentare in Rust sind wie in anderen Sprachen (C, Java), die zwei Arten von Kommentaren unterstützen:

// Dies ist die erste Art der Kommentare
/* Dies ist die zweite Art der Kommentare */ 
/* 
 * Mehrzeiliger Kommentar
 * Mehrzeiliger Kommentar
 * Mehrzeiliger Kommentar
 */

um Anmerkungen für die Dokumentation zu machen

Wird in Rust verwendet // den Inhalt bis zur ersten Zeilenumbruch in einen Kommentar umwandeln.

Unter dieser Regel können drei Backslashes /// Bleibt ein gültiger Kommentarbeginn. Daher kann Rust /// Als Einführung in die Kommentare für die Dokumentation:

///Fügt eine Zahl um eins erhöht. 
/// 
///# 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 einen eleganten Kommentar und kann im IDE angezeigt werden:

Tipp:Cargo hat die Funktion cargo doc, mit der Entwickler die Anmerkungen in Projekten in HTML-Format umwandeln können.