rust / beginner
Snippet
Kommentare im Rust-Code schreiben
Rust unterstützt drei Arten von Kommentaren. Einzeilige Kommentare beginnen mit `//` und gelten bis zum Ende der Zeile. Mehrzeilige Kommentare werden zwischen `/*` und `*/` eingeschlossen und können mehrere Zeilen umfassen. Dokumentationskommentare sind spezielle Kommentare, die mit `///` beginnen und verwendet werden, um Dokumentation für öffentliche Elemente zu generieren. Dokumentationskommentare unterstützen Markdown-Formatierung und können Abschnitte wie Arguments, Returns und Examples enthalten. Kommentare werden vom Compiler vollständig ignoriert und dienen dazu, Code lesbarer und wartbarer zu machen.
snippet.rs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
// This is a single-line comment explaining the main functionfn main() {// Inline comment inside the functionlet x = 10; // This variable holds the value 10/* This is a multi-line comment.It can span multiple lines.Useful for longer explanations. */let y = 20;/// Documentation comment for the calculate function/// Calculates the sum of two numbers/// # Arguments/// * `a` - first number/// * `b` - second number/// # Returns/// The sum of a and bfn calculate(a: i32, b: i32) -> i32 {a + b}println!("Result: {}", calculate(x, y));}
Erklärung
1
// Dies ist ein einzeiliger Kommentar
Einzeiliger Kommentar, der den Code darunter erklärt
2
let x = 10; // Diese Variable speichert...
Inline-Kommentar nach dem Code in derselben Zeile
3
/* Dies ist ein mehrzeiliger Kommentar... */
Mehrzeiliger Kommentarblock, der mehrere Zeilen umfasst
4
/// Dokumentationskommentar...
Dokumentationskommentar zum Generieren von API-Dokumentation
5
/// # Arguments
Markdown-Abschnitt im Dokumentationskommentar mit Parameterliste
6
fn calculate(a: i32, b: i32) -> i32 {
Öffentliche Funktion mit Dokumentationskommentaren, die Zweck und Verwendung beschreiben