注释

注释对任何程序都不可缺少,同样 Rust 支持几种不同的注释方式。

  • 普通注释,其注释内容将被编译器忽略掉:
  • // 单行注释,注释内容直到行尾。
  • /* 块注释, 注释内容一直到结束分隔符。 */
  • 文档注释,其注释内容将被解析成 HTML 帮助文档:
  • /// 对接下来的项生成帮助文档。
  • //! 对封闭项生成帮助文档。
fn main() {
    // 这是行注释的例子
    // 注意这里有两个斜线在本行的开头
    // 在这里面的所有内容编译器都不会读取

    // println!("Hello, world!");

    // 想要运行上述语句?现在请将上述语句的两条斜线删掉,并重新运行。

    /*
     * 这是另外一种格式的注释——块注释。一般而言,行注释是推荐的注释格式,
     * 不过块注释在临时注释大块代码特别有用。/* 块注释可以 /* 嵌套, */ */
     * 所以只需很少按键就可注释掉这些在 main() 函数中的行。/*/*/* 赶紧试试!*/*/*/
     */

     /*
      注意,上面的例子中纵向都有 `*`,这完全是基于格式考虑,实际上这并不是
      必须的。
      */

     // 观察块注释是如何对简单的表达式进行控制,而行注释不能这样操作。
     // 删除注释分隔符将会改变结果。
     let x = 5 + /* 90 + */ 5;
     println!("Is `x` 10 or 100? x = {}", x);
}

参见:

文档注释