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

Способы комментариев в Rust такие же, как и в других языках (C, Java), поддерживают два способа комментариев:

// Это первый способ комментариев
/* Это第二种 способ комментариев */　
/*　
　Многострочный комментарий
　Многострочный комментарий
　Многострочный комментарий
　*/

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

В Rust использование // делает все до первой строки комментария.

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

/// Добавляет один к данному числу.　
///　
/// # Examples　
///　
/// ```　
/// let x = add(1, 2);　
///　
/// ```　
fn add(a: i32, b: i32) -> i32 {　
　　　　return a + b;　
}　
　　　　
fn main() {　
　　　　println!("{}",add(2,3));　
}

Функция add в программе получит элегантный комментарий и может быть отображена в IDE:

Совет:Cargo имеет функцию cargo doc, разработчики могут использовать эту команду для преобразования комментариев в HTML-документации.