Rust教程1.1

这些才是Rust语言基础教程连更,先前写的不够详细请大家看这些。

注释

rust的注释比较特殊,它有自已的语法。

行注释

在rust中注释主要分为两种,其中一种为行注释方法,即为'//',这种注释主要是对某一行的解释说明:

例:

//该区域为注释

fn main(){    

println!("hello world!"); // 打印 Hello World!
}

文档注释

另外一种为rust的文档注释,文档注释使用'///',主要是用来说明函数和结构体,可以使用Markdown标记。这种注释可以通过运行rustdoc命令保存为HTML文件。

实例:

///文档注释:
fn main(){    
    /// 这是主函数    
    println!("Hello World!");    
    /// 打印 Hello World!
}

// Markdown标记:

/// # 这是一个例子
///
/// ```
/// for x in 0..10{
///     println!("{}", x);
/// }
/// ```

但是在下面的注释却会报错。

fn main(){    
    let s = 5; 
    /// 定义变量s的值为5    
    println!("Hello World!"); 
    /// 打印 Hello World!
}

因为文档注释适用于紧随其后的内容,但是不能出现在语句的最后。

rust的文档注释有一种特殊的语法,即代码块注释

例:

/// ```
/// println!("Hello World!");
/// ```

在运行rustdoc后,rustdoc会自动一个main()包装你的代码,使用试探法试图把它放到正确的位置,则其结果为:

fn main(){    
    let s = 5;    
    println!("Hello World!");
}

如果在注释里写其他语言代码,可以在第一个\\\后加语言名字使代码高亮,也是因为rustdoc用一种有意思的方法使用它:它可以用来实际测试你的代码,这样你的注解就不会过时。如果你写了些C代码不过rustdoc会认为它是Rust代码由于你忽略了注解,rustdoc会在你生成文档时提示。

模块注释

Rust还有另一种注释,即模块注释。它用来注释crate、模块和函数,也可以使用Markdown和通过rustdoc命令保存为HTML。例:

//! 这是一个模块。
//! 它的功能是......
//! 这是一个函数。
//! ......

 块注释

rust也可以使用C语言的块注释方法,例:

/*fn main(){
    let mut a: i32 = 0;
    while a >= 10{
        a += 1;
    }
}*/

但是这种注释无法使用rustdoc命令,只是同行注释那样的普通注释。

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值