Комментарии
Все программисты стремятся сделать свой код лёгким для понимания, но иногда требуются дополнительные пояснения. В таких случаях программисты оставляют комментарии в исходном коде, которые компилятор игнорирует, но которые люди, читающие исходный код, могут найти полезными.
Вот простой комментарий:
#![allow(unused)]
fn main() {
// hello, world
}
В Rust идиоматический стиль комментариев начинается с двух косых черт, и
комментарий продолжается до конца строки. Для комментариев, выходящих за пределы
одной строки, нужно включать // на каждой строке, вот так:
#![allow(unused)]
fn main() {
// Здесь мы делаем что-то сложное, настолько длинное, что нам нужно
// несколько строк комментариев, чтобы это объяснить! Уф! Надеюсь, этот комментарий
// объяснит, что здесь происходит.
}
Комментарии также можно размещать в конце строк, содержащих код:
Имя файла: src/main.rs
fn main() {
let lucky_number = 7; // Сегодня мне везёт
}
Но чаще вы увидите их в таком формате, с комментарием на отдельной строке над кодом, который он аннотирует:
Имя файла: src/main.rs
fn main() {
// Сегодня мне везёт
let lucky_number = 7;
}
В Rust также есть другой вид комментариев — документационные комментарии, которые мы обсудим в разделе «Публикация крейта на Crates.io» главы 14.