комментарий

Примечание

Если вы изучали C, C++, Java или C#, этот урок можно пропустить. Дело в том, что комментарии в Rust работают почти так же, как в этих языках.

Что такое комментарий?

Пояснительный текст для человека, который игнорируется компилятором и не участвует в выполнении программы.

Какие задачи решают комментарии?

• Объяснение логики кода: помогает другим понять назначение фрагментов кода
• Хранение сведений о разработке: используется для автоматической генерации документации
• Временное отключение кода: сохранить фрагмент без удаления, но предотвратить его запуск через комментарии
• Улучшение читаемости кода

Два / три вида комментариев в Rust

• Строчный комментарий: начинается с // и действует до конца строки
• Блочный комментарий: позволяет обрамить несколько строк кода, работает на нескольких строках, синтаксис /* ... */

Комментарии похожи на заметки, которые вы делаете в учебниках для лучшего понимания материала.

Сначала разберем два самых распространенных варианта комментариев, позже изучим третий.

fn main() {
    // Строчный комментарий начинается с двух косых черт и длится до конца строки.
    // Все символы после косых черт в этой строке игнорируются компилятором.

    // Пример: эта строка кода не будет выполнена
    // println!("Hello, world!");

    // Попробуйте убрать верхние косые черты и запустить код повторно.

    /*
     * Блочные комментарии удобны для временного отключения кода, смотрите пример ниже
     * Поддерживается вложенность: /* вот так */, быстрое комментирование больших участков кода.
     */

    /*
     * println!("Hello, world!");
     * println!("Hello, world2!");
     */

    /*
    Важно: звездочки в левом столбце нужны только для визуального оформления,
    они не являются обязательной частью синтаксиса языка, их можно не писать.
    */

    // Достаточно добавить или убрать одну косую черту, чтобы быстро включать/отключать блочный комментарий:

    /* <- Добавьте сюда еще одну косую черту, чтобы снять комментирование со всего нижнего блока (перед /* поставьте /, получится //*, попробуйте сами)
    
    println!("Теперь");
    println!("Весь");
    println!("код будет выполняться!");
    // Внутренние строчные комментарии не пострадают

    // */

    // Блочные комментарии можно также вставлять посреди выражений:
    let x = 5 + /* 90 + */ 5;
    println!("`x` равен 10 или 100? x = {}", x);
}Code language: PHP (php)

Скопируйте приведенный код и протестируйте самостоятельно, особенно фрагмент с пометкой /* <- Добавьте сюда еще одну косую черту, чтобы снять комментирование со всего нижнего блока

(Пояснение: если поставить / перед /*, получится //* — маркер начала блочного комментария перестает работать, а конструкция // */ в конце воспринимается как строчный комментарий.)

Таким образом блочный комментарий временно отменяется, а все операторы println внутри начнут выполняться.

Документационные комментарии

С помощью специальных утилит из документационных комментариев генерируются документы формата HTML для удобного изучения разработчиками. Этой теме мы посвятим отдельный следующий урок.