Rust – Комментарии

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

• Недокументированные комментарии
  • Однострочные комментарии
  • Многострочные комментарии
• Комментарии к документу
  • Внешние комментарии к документу
  • Внутренние комментарии к документу

Недокументированные комментарии

Однострочные комментарии

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

Пример 1:

// Rust code for a single line comment

fn main() {

    println!("Hello, world!");

      //this text is ignored

}

Выход:

Насколько мы можем судить, код внутри комментария не соблюдался и, следовательно, не вызывал никаких ошибок.

Многострочные комментарии

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

Пример 2:

// Rust code for Multiline comments

fn main() {

    println!("Hello, world!");

    /* this is a

    multine 

    comment

    */

    println!("Hello, Geeks!")

}

Выход:

Комментарии документа

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

• Внешние комментарии к документу
• Внутренние комментарии к документу

Комментарии внешнего документа

Мы используем комментарии внешнего документа для документирования некоторого кода вне блока. Это помогает узнать общий обзор объекта в коде.

Пример 3:

// Rust code for main function 

// simply prints hello geeks

fn main() {

   println!("Hello, Geeks!")

}

Выход:

Комментарии внутреннего документа

Комментарий внутренней документации можно использовать для получения подробной документации внутри блока кода. Это можно использовать с //!

Пример 4:

// Rust code for inner doc comments

fn main() {

    greet()

}

 

/// greet function simply prints hello geeks

fn greet(){

    //! This is a simple greet

    println!("Hello, Geeks!")

}

Выход: