Rust 中的注釋方式與其它語言(C、Java)一樣,支持兩種注釋方式:
// 這是第一種注釋方式 /* 這是第二種注釋方式 */ /* * 多行注釋 * 多行注釋 * 多行注釋 */
在 Rust 中使用 // 可以使其之后到第一個換行符的內容變成注釋。
在這種規(guī)則下,三個反斜杠 /// 依然是合法的注釋開始。所以 Rust 可以用 /// 作為說明文檔注釋的開頭:
///?Adds?one?to?the?number?given. /// ///?#?Examples /// ///?``` ///?let x = add(1, 2); /// ///?``` fn add(a: i32, b: i32) -> i32 { return a + b; } fn main() { println!("{}",add(2,3)); }
程序中的函數 add 就會擁有一段優(yōu)雅的注釋,并可以顯示在 IDE 中:
Tip:Cargo 具有 cargo doc 功能,開發(fā)者可以通過這個命令將工程中的說明注釋轉換成 HTML 格式的說明文檔。