15-编写文档

选择背景色：黄橙洋红淡粉水蓝草绿白色选择字体：宋体黑体微软雅黑楷体选择字体大小：小中大特恢复默认

为了编写文档，Rust提供了表示文档注释开头的特殊符号。文档采用类似的方式编写，但与普通代码文档注释相比，它们的处理方式不同，并且由rustdoc解析。文档注释分为两个层级，并使用单独的符号来标记文档注释的开头。

元素级：这些注释适用于模块中的元素，例如结构体、枚举声明、函数及特征常量等。它们应该出现在元素的上方。对于单行注释，它们以“///”开头，而对于多行注释，则以“/”开头，以“/”结尾。
模块级：这些是出现在根层级的注释，例如main.rs、lib.rs，以及其他任意模块，可使用“//！”表示单行注释的开始，使用“/!”表示多行注释的开始，并将“/”作为结尾标记。它们适用于概述软件包和某些示例。

在文档注释中，你可以使用通常的markdown语法编写文档。它还支持在倒引号中编写有效的Rust代码（'''let a= 23 ; '''），这将成为文档测试的一部分。

用于编写注释的上述表示方法实际上是#[doc="your doc comment"]属性的语法糖，它们被称为文档属性（doc attribute）。当rustdoc解析包含“///”或“/*”符号的代码行时，将会把它们转换成文档属性。此外，你也可以使用这些文档属性编写文档。