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

Комментарии

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

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

#![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.