Rust语法之注释

既然已经学习了函数,学习注释是个不错的主意。注释是你留给其他程序员帮助介绍你的代码的笔记。编译器将绝大部分的忽略他们。

你需要注意的是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!。这个宏比较两个值,如果不相等程序就会出错退出。这在文档中是非常有用的。还有另外一个宏assert!,如果是false程序就报错退出。

你可以使用rustdoc工具从这些文档注释生成HTML文档,并且可以在tests中运行这些示例代码。

时间: 2024-10-09 21:23:51

Rust语法之注释的相关文章

JavaScript基本语法(注释)

//表示当前行的其他部分是注释而不是要执行的代码,所以解释器不会试图运行它 /*表示一个多行注释的开始 */表示一个多行注释的结束 大括号()和{}用来表示一个代码块.它们确保大括号中间的所有行都被当作一个代码块来看待. 当我们在讨论if或for这样的结构语句和函数时,你会看到有关大括号更多的应用 分号或换行定义了语句的结束,语句就是一个单行命令.在实际应用中,分号是可选的. 但是在语句结束的时候,可以使用它们来使代码更清晰,更有条理,因为这样做可以使 代码更容易阅读和调试(尽管你可以把很多语句

2.1php标签,语法,注释

*本节视频和图例请看百度云:http://pan.baidu.com/s/1getBENp 预定义变量常量+变量传值 1回顾+php标签 2php语法+注释+量(变量+常量) 3预定义变量+预定义常量 4php代码执行过程+代码执行内存分析 5变量传值(值传递+引用传递)+可变变量+整型数据类型 6数据类型(浮点型+布尔型+字符串(单引号+双引号+定界符)) 回顾 搭建独立环境 基础知识:HTML,网站(服务器,IP,域名),网站访问流程 搭建环境:Apache,php和mysql Apache

IT兄弟连 Java语法教程 注释与编码规范

在程序代码中适当地添加注释可以提高程序的可读性和可维护性.好的编码规范可以使程序更易阅读和理解.下面将介绍Java中的集中代码注释以及应该注意的编码规范. 代码注释 通过在程序代码中添加注释可提高程序的可读性.注释中包含了程序的信息,可以帮助程序员更好的阅读和理解程序.在Java源程序文件的任意位置都可添加注释语句.注释中的文字Java编译器不进行编译,所有代码中的注释文字对程序不产生任何影响.Java语言提供了3种添加注释的方法,分别为单行注释.多行注释和文档注释. ●  单行注释 “//”为

Java基础语法(一)<注释,关键字,常量,变量,数据类型,标识符,数据类型转换>

从今天开始,记录学习Java的过程.要学习Java首先得有环境,至于环境的安装我就不说了,百度有很多教程,比如:http://jingyan.baidu.com/article/20095761904f25cb0721b4b7.html JVM.JRE.JDK: jvm是Java虚拟机,用来执行程序的. jre是Java的运行环境:如果只是为了运行java程序,只需要装jre环境就ok:其中包含了jvm和核心库. jdk是Java的开发开发工具包,包含了常用的开发工具,也包含了jre: 三者之间

Rust语法之原生数据类型(一)

Rust语言有一些被认为是原生类型的数据类型.这意味着它们是语言内建的.Rust是这样的一种结构,这种结构是标准库在这些类型上提供了一些有用的类型,但是这些才是最原始的. Booleans Rust有一个内置的boolean类型,名为bool.有两个值:true和false: let x = true; let y: bool = false; boolean型一个常用的地方是if 条件. 你可以从标准库文档中找到更多关于bool的信息. char char类型代表了一个Unicode范围的值.

smarty基本语法之注释及变量输出

1.注释 {* 注释美容 *} 2.输出已赋值变量 (1).变量为字符串: {$article_title} (2).变量为一维数组 : {$arr.title} 或 {$arr[title]} 变量为多维数组 :  {$arr.article.title} 或 {$arr[article][title]} (3).变量为类:     {$obj->title} {$obj->function()}

PHP的基本语法_注释

PHP支持C.C++和Shell脚本风格的注释,如下: //... ... 单行注释 /* ... ... */ 多行注释 (注意:不能嵌套) # ... ... 脚本注释 /** */ 文档注释 程序员在编程时使用注释是一种良好的习惯,优点: 写过不合适的代码注释 写帮助文档 调试程序 注意: 注释要写在代码的上面或是右边

pycharm使用python语法(注释)

单行注释,使用#号,事例: 多行注释方法一:选择多行代码后ctrl+/,多行#注释,快捷注释,取消也是ctrl+/,事例: 多行注释方法二:'''     '''',事例: 原文地址:https://www.cnblogs.com/huanyingnidedaolai/p/10884262.html

Rust 1.7.0 语法基础 attribute

一.语法 attribute : '#' '!' ? '[' meta_item ']' ; meta_item : ident [ '=' literal | '(' meta_seq ')' ] ? ; meta_seq : meta_item [ ',' meta_seq ] ? ; 二.说明 使用Java的人都知道,Java有个 annotation 注解. Rust 也有注释,名称和C#的注释一样,叫做 attribute. Rust attribute 用于在源代码中标识编译过程中的