Комментарии
Все программисты стремятся сделать свой код простым для понимания, но иногда нужны дополнительные пояснения. В таких случаях программисты оставляют комментарии в исходном коде: компилятор их игнорирует, но людям, читающим код, они могут быть полезны.
Вот простой комментарий:
#![allow(unused)]
fn main() {
// привет, мир
}В 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.