Типы комментариев и документация в Rust

Введение

В этом практическом занятии мы узнаем о различных видах комментариев, поддерживаемых Rust, в том числе о обычных комментариях и комментариях документации. Обычные комментарии могут быть комментариями в строке, которые начинаются с двух косых черточек и продолжаются до конца строки, или комментариями в блоке, которые заключаются между /* и */ и могут быть вложенными. Комментарии документации, с другой стороны, используются для генерации HTML-документации библиотеки и начинаются с /// или //!.

Примечание: Если практическое занятие не задает имя файла, вы можете использовать любое имя файла, которое хотите. Например, вы можете использовать main.rs, скомпилировать и запустить его с помощью rustc main.rs &&./main.

Комментарии

Любая программа требует комментариев, и Rust поддерживает несколько различных типов:

• Обычные комментарии, которые игнорируются компилятором:
  • // Комментарии в строке, которые продолжаются до конца строки.
  • /* Блочные комментарии, которые продолжаются до закрывающего разделителя. */
• Комментарии документации, которые разбираются в HTML-документацию библиотеки:
  • /// Генерирует документацию для библиотеки для следующего элемента.
  • //! Генерирует документацию для библиотеки для окружающего элемента.

fn main() {
    // Это пример комментария в строке.
    // В начале строки есть две косые черточки.
    // Ничего, написанное после них, не будет прочитано компилятором.

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

    // Запустите его. Видите? Теперь попробуйте удалить две косые черточки и запустить снова.

    /*
     * Это другой тип комментария, блочный комментарий. В общем,
     * комментарии в строке - рекомендуемый стиль комментирования. Но блочные комментарии
     * чрезвычайно полезны для временного отключения фрагментов кода.
     * /* Блочные комментарии могут быть /* вложенными, */ */ поэтому для комментирования всего в этой функции main() требуется только несколько нажатий клавиш.
     * /*/*/* Попробуйте сами! */*/*/
     */

    /*
    Примечание: Предыдущий столбец `*` был целиком для стиля. На самом деле его нет необходимости.
    */

    // С помощью блочных комментариев легче манипулировать выражениями,
    // чем с помощью комментариев в строке. Попробуйте удалить разделители комментария,
    // чтобы изменить результат:
    let x = 5 + /* 90 + */ 5;
    println!("`x` равно 10 или 100? x = {}", x);
}

Резюме

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