Komentarze

Wszyscy programiści starają się tworzyć czytelny i zrozumiały kod, jednak czasem potrzebne jest dodatkowe wyjaśnienie. W takich wypadkach programiści umieszczają w kodzie notki lub komentarze, które mimo że są ignorowane przez kompilator, mogą okazać się przydatne dla osób czytających kod.

Oto prosty komentarz:

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

W Ruście, komentarze muszą rozpoczynać się dwoma ukośnikami i ciągną się do końca linii. W przypadku komentarzy, których długość przekracza jedną linię, musisz wstawić // na początku każdej linii, tak jak poniżej:

#![allow(unused)]
fn main() {
// A więc opisujemy tu coś skomplikowanego, wystarczająco długo,
// że potrzebujemy wieloliniowych komentarzy, aby to zrobić!
// Fiu! Fiu! Na szczęście ten komentarz wyjaśni, o co chodzi.
}

Komentarze mogą być też umieszczone na końcu linii zawierającej kod:

Plik: src/main.rs

fn main() {
    let lucky_number = 7; // Czuję, że sprzyja mi dziś szczęście
}

Jednak częściej spotkasz się z zapisem, w którym komentarz znajduje się w oddzielnej linii nad kodem, który jest przez niego opisywany:

Plik: src/main.rs

fn main() {
    // Czuję, że sprzyja mi dziś szczęście
    let lucky_number = 7;
}

Rust posiada też wbudowany inny typ komentarzy, komentarze dokumentacji, które omówimy w sekcji "Publikacja skrzyni w Crates.io" rozdziału 14.