Rust 註釋介紹

導讀	Rust 語言是一種高效、可靠的通用高階語言。其高效不僅限於開發效率，它的執行效率也是令人稱讚的，是一種少有的兼顧開發效率和執行效率的語言。

Rust 中的註釋方式與其它語言（C、Java）一樣，支援兩種註釋方式：

例項

// 這是第一種註釋方式
/* 這是第二種註釋方式 */
/* 

 * 多行註釋

 * 多行註釋

 * 多行註釋

 */

在 Rust 中使用 // 可以使其之後到第一個換行符的內容變成註釋。

在這種規則下，三個反斜槓 /// 依然是合法的註釋開始。所以 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 就會擁有一段優雅的註釋，並可以顯示在 IDE 中：

Tip：Cargo 具有 cargo doc 功能，開發者可以透過這個 將工程中的說明註釋轉換成 HTML 格式的說明文件。

原文來自：