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次浏览

开启你的 职业生涯

通过完成课程获得认证

开始
广告