Rust 注释介绍

导读 Rust 语言是一种高效、可靠的通用高级语言。其高效不仅限于开发效率,它的执行效率也是令人称赞的,是一种少有的兼顾开发效率和执行效率的语言。

Rust 注释介绍Rust 注释介绍

Rust 中的注释方式与其它语言(C、Java)一样,支持两种注释方式:

实例

// 这是第一种注释方式
/* 这是第二种注释方式 */
/* 

 * 多行注释
 * 多行注释
 * 多行注释
 */
用于说明文档的注释

在 Rust 中使用 // 可以使其之后到第一个换行符的内容变成注释。

在这种规则下,三个反斜杠 /// 依然是合法的注释开始。所以 Rust 可以用 /// 作为说明文档注释的开头:

实例

/// Adds one to the number given. 
/// 
/// # Examples 
/// 
/// ``` 
/// let x = add(1, 2); 
/// 
/// ``` 
fn add
(a
: 
i32
, b
: 
i32
) 
-> 
i32 
{
    
return a 
+ b
;
}
    

fn main ( ) {     println ! ( "{}" ,add ( 2 , 3 ) ) ; }

程序中的函数 add 就会拥有一段优雅的注释,并可以显示在 IDE 中:
Rust 注释介绍Rust 注释介绍
Tip:Cargo 具有 cargo doc 功能,开发者可以通过这个 命令将工程中的说明注释转换成 HTML 格式的说明文档。

原文来自: https://www.linuxprobe.com/introduction-to-rust.html

请使用浏览器的分享功能分享到微信等