Rust程式設計中的註釋


Rust中的註釋是會被rust編譯器和直譯器忽略的語句。主要用於幫助理解程式碼。

在程式設計中,我們通常會寫註釋來解釋不同方法、變數或函式的工作原理,便於閱讀我們程式碼的人員理解。

註釋可以提高程式碼的可讀性,特別是在程式碼中的識別符號未正確命名時。

在Rust語言中有多種宣告註釋的方式,主要包括:

  • 單行註釋

  • 多行註釋

  • Doc註釋

本文將探討這三種註釋。

單行註釋

Rust中的單行註釋是指以換行符結尾的註釋。它們使用//(兩個正斜槓)。

語法

// this is a comment

示例

fn main() {
   // single line comment
   // println!("also a comment");
   println!("Hello, world!");
}

在上例中存在兩個單行註釋,編譯器將忽略它們。

輸出

Hello, world!

多行註釋

顧名思義,多行註釋是跨多行的註釋。它們使用/* -- */

語法

/* this
   is
   a
   comment
*/

示例

fn main() {
   /*
      a
      multi
      line
      comment
   */
   println!("Hello, world!");
}

輸出

Hello, world!

Doc註釋

Rust語言中的Doc註釋,可用於指定方法、函式或類似識別符號的工作原理。

在Rust語言中,可以使用///(三個正斜槓)編寫Doc註釋。

語法

/// doc comment

Rust中的一個簡單示例:

/// This function returns the greeting; Hello, world!
pub fn hello() -> String {
   ("Hello, world!").to_string()
}

更新於: 2021年5月21日

742次瀏覽

開啟你的 職業生涯

透過完成課程獲得認證

開始
廣告