Мова програмування Rust

Коментарі (Comments)

Усі програмісти прагнуть зробити свій код легким для розуміння, але іноді потрібне додаткове пояснення. У таких випадках програмісти залишають коментарі у своєму вихідному коді, які компілятор ігноруватиме, але які можуть бути корисними для людей, що читають вихідний код.

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

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

У Rust ідіоматичний стиль коментарів починає коментар двома слешами, і коментар триває до кінця рядка. Для коментарів, що виходять за межі одного рядка, вам потрібно буде додавати // у кожному рядку, ось так:

#![allow(unused)]
fn main() {
// So we're doing something complicated here, long enough that we need
// multiple lines of comments to do it! Whew! Hopefully, this comment will
// explain what's going on.
}

Коментарі також можна розміщувати в кінці рядків, що містять код:

Filename: src/main.rs

fn main() {
    let lucky_number = 7; // I'm feeling lucky today
}

Але ви частіше бачитимете їх використаними в такому форматі, коли коментар розміщується на окремому рядку над кодом, який він анотує:

Filename: src/main.rs

fn main() {
    // I'm feeling lucky today
    let lucky_number = 7;
}

Rust також має інший вид коментарів, документаційні коментарі (documentation comments), які ми обговоримо в розділі “Публікація крейта на Crates.io (Publishing a Crate to Crates.io)” Розділу 14.