Комментарии в Rust
Комментирование в Rust, как и в других языках (C, Java), поддерживает два стиля комментариев:
Пример
// Это первый стиль комментариев
/* Это второй стиль комментариев */
/*
* Многострочный комментарий
* Многострочный комментарий
* Многострочный комментарий
*/
/* Это второй стиль комментариев */
/*
* Многострочный комментарий
* Многострочный комментарий
* Многострочный комментарий
*/
Документирующие комментарии
В Rust использование//превращает содержимое после него до первого перевода строки в комментарий.
Согласно этому правилу, три косые черты///всё ещё являются допустимым началом комментария. Поэтому Rust может использовать///как начало документационных комментариев:
Пример
/// Добавляет единицу к заданному числу.
///
/// # Примеры
///
/// ```
/// let x = add(1, 2);
///
/// ```
fn add(a: i32, b: i32) -> i32 {
return a + b;
}
fn main() {
println!("{}",add(2,3));
}
///
/// # Примеры
///
/// ```
/// 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.
Другие расширения