Комментарии - Язык программирования Rust

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

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


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

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


#![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 есть ещё один вид комментариев - документационные комментарии, которые мы обсудим в разделе "Публикация пакета на Crates.io" главы 14.