在 Rust 里面注釋分成兩種,行注釋和塊注釋。它的形式和 C 語言是一樣的。 兩種注釋分別是:
- 行注釋使用
//
放在注釋前面。比如:
// I love Rust, but I hate Rustc.
- 塊注釋分別使用
/*
和*/
包裹需要注釋的內(nèi)容。比如:
/* W-Cat 是個大胖貓,N-Cat 是個高度近視貓。*/
Rust 自帶有文檔功能的注釋,分別是///
和//!
。支持 Markdown 格式
///
用來描述的它后面接著的項。//!
用來描述包含它的項,一般用在模塊文件的頭部。
比如在 main.rs 文件中輸入以下內(nèi)容: //! # The first line
//! The second line
/// Adds one to the number given.
///
/// # Examples
///
/// ```
/// let five = 5;
///
/// assert_eq!(6, add_one(5));
/// # fn add_one(x: i32) -> i32 {
/// # x + 1
/// # }
/// ```
fn add_one(x: i32) -> i32 {
x + 1
}
rustdoc main.rs
或者
cargo doc