Język programowania Rust

Komentarze

Wszyscy programiści dążą do tego, aby ich kod był łatwy do zrozumienia, ale czasami wymagane jest dodatkowe wyjaśnienie. W takich przypadkach programiści pozostawiają komentarze w swoim kodzie źródłowym, które kompilator zignoruje, ale które osoby czytające kod źródłowy mogą uznać za przydatne.

Oto prosty komentarz:

#![allow(unused)]
fn main() {
// witaj, świecie
}

W Ruście idiomatyczny styl komentarzy rozpoczyna komentarz dwoma ukośnikami, a komentarz trwa do końca linii. W przypadku komentarzy, które rozciągają się poza jedną linię, należy umieścić // na każdej linii, w ten sposób:

#![allow(unused)]
fn main() {
// Więc robimy tutaj coś skomplikowanego, na tyle długiego, że potrzebujemy
// wielu linii komentarzy, żeby to zrobić! Uff! Mamy nadzieję, że ten komentarz
// wyjaśni, co się dzieje.
}

Komentarze mogą być również umieszczane na końcu wierszy zawierających kod:

Nazwa pliku: src/main.rs

fn main() {
    let lucky_number = 7; // Czuję się dzisiaj szczęściarzem
}

Ale częściej zobaczysz je używane w tym formacie, z komentarzem w osobnej linii powyżej kodu, który opisuje:

Nazwa pliku: src/main.rs

fn main() {
    // Czuję się dzisiaj szczęściarzem
    let lucky_number = 7;
}

Rust ma również inny rodzaj komentarzy, komentarze dokumentacyjne, które omówimy w sekcji „Publikowanie skrzynki na Crates.io” w Rozdziale 14.