任何程序都需要注释(comment),Rust甚至支持几种不同的格式:
- 一般注释(Regular comments) 会被编译器忽略掉:
// 行注释,对整行有效.
/* 块注释,在相应的界定符内有效 */
- 文档注释(Doc comments) 会被解析为HTML文档:
/// 为下面代码生成库文档
//! 为本行生成库文档
fn main() {
// 这是单行注释的示例
// 请注意,如果有两个斜杠在该行的开头,那么编译器将不会读取任何写在这里的内容
// println!("Hello, world!");
// 运行它?请先删除前面的两个斜杠。
/*
* 这是另外一种类型的注释,块注释(block comment). 一般来说,
* 该行注释是推荐的注释风格,不过块注释对于调试(debug)来说是非常有用的
*/
/*
注意,注释行前面的 `*`完全是一种风格,实际上它也不是必须的。
*/
// 观察块注释如何让表达式的操作变的更容易
// 而行注释无法做到这样。
// 删除分隔符来改变结果:
let x = 5 + /* 90 + */ 5;
println!("Is `x` 10 or 100? x = {}", x);
}
更多文档:
Library documentation