Rust 编程中的评论

Rust 中的注释是被 Rust 编译器和解释器忽略的语句。它们主要用于人类对代码的理解。

通常，在编程中，我们编写注释来向阅读我们代码的任何人解释不同函数、变量或方法的工作。

注释增强了代码的可读性，尤其是当代码中的标识符命名不正确时。

在 Rust 中，我们可以通过多种方式声明注释。主要是这些 -

• 单行注释

• 多行注释

• 文档评论

在本文中，我们将探讨所有三个评论。

单行注释

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!

文档评论

在 Rust 中，Doc 注释是用于指定方法、函数或类似标识符的工作的注释。

我们在 Rust 中编写文档注释，使用 ///（三个正斜杠）

语法

/// doc comment

Rust 中的一个简单示例，

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