The Rust Programming Language

Комментарии

All programmers strive to make their code easy to understand, but sometimes extra explanation is warranted. In these cases, programmers leave comments in their source code that the compiler will ignore but that people reading the source code may find useful.

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

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