The Rust Programming Language

Комментарии

Все хорошие программисты, создавая программный код, стремятся сделать его простым для понимания. Бывают всё же случаи, когда дополнительное описание просто необходимо. В этих случаях программисты пишут заметки (или как их ещё называют, комментарии). Комментарии игнорируются компилятором, но для тех кто код читает - это очень важная часть документации.

Пример простого комментария:

#![allow(unused)]
fn main() {
// Hello, world.
}

В Rust комментарии должны начинаться двумя символами // и простираются до конца строки. Чтобы комментарии поместились на более чем одной строке, необходимо разместить их на каждой строке, как в примере:

#![allow(unused)]
fn main() {
// So we’re doing something complicated here, long enough that we need
// multiple lines of comments to do it! Whew! Hopefully, this comment will
// explain what’s going on.
}

Комментарии могут быть размещены в конце строки имеющей код:

Файл: src/main.rs

fn main() {
    let lucky_number = 7; // I’m feeling lucky today
}

Но чаще вы увидите их использованные в следующем формате, здесь комментарий размещён на отдельной строке над кодом, который комментируется:

Файл: src/main.rs

fn main() {
    // I’m feeling lucky today
    let lucky_number = 7;
}

Также в Rust есть другой тип комментариев - документирующие комментарии, они используются в документации, и их обсуждаются разделе "Публикация пакета на Crates.io" Главы 14.