Язык программирования Rust

Комментарии

Все программисты стремятся писать легко читаемый код, но иногда может потребоваться дополнительное пояснение. В таких случаях программисты оставляют комментарии в исходном коде — компилятор их игнорирует, а люди, читающие код, могут найти их полезными.

Вот простой комментарий:

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

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

#![allow(unused)]
fn main() {
// Здесь мы делаем что-то сложное, настолько, что требуется
// несколько строк комментариев! Фух! Надеюсь, этот комментарий
// объясняет, что происходит.
}

Или можно использовать синтаксис многострочных комментариев с /* и */:

#![allow(unused)]
fn main() {
/* Здесь мы делаем что-то сложное, настолько, что требуется
   несколько строк комментариев! Фух! Надеюсь, этот комментарий
   объясняет, что происходит. */
}

Комментарии также можно размещать в конце строк с кодом:

Имя файла: 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 также есть другой вид комментариев — комментарии документации, которые мы обсудим в разделе 14 «Публикация крейта на Crates.io» publishing.