Пояснения и аннотации комментариев в Rust

Введение

Добро пожаловать в Комментарии. Эта лабораторная работа является частью Rust Book. Вы можете практиковать свои навыки Rust в LabEx.

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

Комментарии

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

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

// hello, world

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

// Так что здесь мы делаем что-то сложное, настолько сложное, что нужно
// несколько строк комментариев, чтобы это описать! Фу! Надеюсь, этот комментарий
// объяснит, что происходит.

Комментарии также могут быть помещены в конце строк, содержащих код:

Имя файла: src/main.rs

fn main() {
    let lucky_number = 7; // Я чувствую сегодня удачу
}

Но чаще вы будете видеть их в таком формате, когда комментарий находится на отдельной строке выше кода, который он комментирует:

Имя файла: src/main.rs

fn main() {
    // Я чувствую сегодня удачу
    let lucky_number = 7;
}

В Rust также есть другой тип комментариев - комментарии документации, о которых мы поговорим в разделе "Публикация пакета на Crates.io".

Резюме

Поздравляем! Вы завершили лабораторную работу по Комментариям. Вы можете практиковаться в других лабораторных работах в LabEx, чтобы улучшить свои навыки.