Rust 2.7 注释

10 Jan 2015 by LelouchHe

原文链接

现在我们有了函数,再学习写注释的功能.注释通常是你写给其他程序员用来解释代码原理的.编译器基本都会忽略的.

Rust有2种注释,行注释(line comment)和文档注释(doc comment)

// 行注释以"//"开头,到行尾结束

let x = 5; // 这也是行注释

// 注释太长的话,可以把行注释并列起来
// 同时,在"//"和后续注释之间留一个空格
// 这样可读性更好

另一种就是文档注释了.该注释以”///”开头,内部支持Markdown语法

/// `hello` is a function
/// # Arguments
/// * `name`- the name
/// # Example

写文档注释时,添加下参数,返回值和函数示例是非常有用的.

你可以使用rustdoc工具来从这些注释中提取文档.