注释

所有程序员都力求使其代码易于理解，不过有时还需要提供额外的解释。写注释是为了帮助别人理解你的代码。 这也有利于帮助你以后理解你的代码。

代码注释

在 Rust 中，常用的注释样式是以两个斜杠开始注释，并持续到本行的结尾。对于超过一行的注释，需要在每一行前都加上 //，示例：

 // So we’re doing something complicated here, long enough that we need
 // multiple lines of comments to do it! Whew! Hopefully, this comment will
 // explain what’s going on.

或者也可以使用/*...*/进行注释，示例：

 fn main() {
     let some_number/*: i16*/ = 100;
 }

文档注释

除了代码的注释外，对于包的描述文字的注释也需要。准确的包文档有助于其他用户理解如何以及何时使用他们。

Rust 也有特定的用于文档的注释类型，通常被称为 文档注释（documentation comments），注释会生成 HTML 文档。这些 HTML 展示公有 API 文档注释的内容，这些注释意在让对库感兴趣的程序员理解如何 使用 这个包。

文档注释使用 /// 来注释文本，文档注释就位于需要文档的项之前。

示例：

 /// Adds one to the number given.
 ///
 /// # Examples
 ///
 /// ```
 /// let arg = 5;
 /// let answer = my_crate::add_one(arg);
 ///
 /// assert_eq!(6, answer);
 /// ```
 pub fn add_one(x: i32) -> i32 {
     x + 1
 }

下表展示了Rust中写注释的符号。

符号	注释
//	行注释
//!	内部行文档注释
///	外部行文档注释
/*...*/	块注释
/*!...*/	内部块文档注释
/**...*/	外部块文档注释