既然我们对函数有了一定了解之后,那么学习下如何写注释是不错的。注释的作用在于它能够帮助其他的程序员更好的理解你的代码。而编译期通常会忽视他们。
Rust 中有两种你应该学习的注释方式:行注释和文档注释。
// Line comments are anything after ‘//’ and extend to the end of the line.
let x = 5; // this is also a line comment.
// If you have a long explanation for something, you can put line comments next
// to each other. Put a space between the // and your comment so that it’s
// more readable.
另一种注释是文档注释。文档注释使用 /// 而不是 //,并且在该注释部分中支持 markdown 注解文法:
/// Adds one to the number given.
///
/// # Examples
///
/// ```
/// let five = 5;
///
/// assert_eq!(6, add_one(5));
/// ```
fn add_one(x: i32) -> i32 {
x + 1
}
在编写文档注释时提供一些程序使用的例子是非常有用的。你会注意到在这里我们使用了一个新的宏: assert_eq!。它将两个值进行比较,如果两个值不相等就会调用 panic!。这是非常有用的文档说明。还有另一个宏,assert!,如果它的参数值是 false,那么同样会触发 panic! 的执行。
您可以使用 rustdoc 工具从这些文档注释生成HTML文档,并运行测试代码来尝试一下!
ASP.NET CheckBox TextAlign 属性 CheckBox 控件定义和用法 TextAlign 属性用于设置或返回 CheckBox 文本的对齐方式。 默认的对...
ASP.NET BorderWidth 属性 Style 控件定义和用法 BorderWidth 属性用于设置或返回控件的边框宽度。 语法asp:webcontrol id="id" ...
ASP.NET ListItem 控件 Web 服务器控件定义和用法 ListItem 控件可创建列表中的一个项目。 此控件与以下列表控件一同使用:asp:L...
在以下的内容中,你将了解什么是Razor?如何添加 Razor 代码?RazorC# 与 VB 的语法规则是什么?在本教程中,我们将使用 C# 和 V...
让我们编写一个简单的 Ruby 程序。所有的 Ruby 文件扩展名都是 .rb。所以,把下面的源代码放在 test.rb 文件中。 实例 #!/usr/bi...