【用Rust写CAD】第二章 第一节 Rust注释

news/2024/11/6 13:11:31 标签: rust, 开发语言

文章目录

  • 1、普通注释
  • 2、用于说明文档的注释


1、普通注释

Rust 中的注释方式与其它语言(C、C++、Java)一样,支持两种注释方式:

rust">// 这是第一种注释方式

/* 这是第二种注释方式 */

/*
 * 多行注释
 * 多行注释
 * 多行注释
 */

2、用于说明文档的注释

在 Rust 中使用 // 可以使其之后到第一个换行符的内容变成注释。
在这种规则下,三个正斜杠 /// 依然是合法的注释开始。所以 Rust 可以用 /// 作为说明文档注释的开头:

rust">/// Adds one to the number given.
///
/// # Examples
///
/// ```
/// let x = add(1, 2);
///
/// ```

fn add(a: i32, b: i32) -> i32 {
    return a + b;
}
   
fn main() {
    println!("{}",add(2,3));
}

程序中的函数 add 就会拥有一段优雅的注释,并可以显示在 IDE 中:
在这里插入图片描述
Cargo 具有 cargo doc 功能,开发者可以通过这个命令将工程中的说明注释转换成 HTML 格式的说明文档。


http://www.niftyadmin.cn/n/5740922.html

相关文章

雷军-2022.8小米创业思考-11-新零售:用电商思维做新零售,极致的效率+极致的体验。也有弯路,重回极致效率的轨道上。

第十一章 新零售 当我们说到小米模式的时候,其实我们说的是两件东西: 一是小米模式的本质,即高效率的商业模式; 另一件是小米这家公司具象的商业模式,这是小米在实践中摸索、建立的一整套业务模型。 从2015年到202…

Nginx中的缓存与压缩配置

1. Nginx中的缓存介绍 由于 Nginx 是在网站的所有其他后台服务的最前线,它接收的请求和流量是后台服务的数倍甚至数十倍之多。因此,用好 Nginx 的缓存功能对于大型网站而言至关重要。Nginx 中的缓存功能优势如下: 提升所有客户端体验 有效降…

【Postman深入测试接口的详细指南】保姆级

Postman深入测试接口的详细操作步骤 一、创建测试集合二、使用环境变量三、编写请求四、编写测试脚本五、数据驱动测试六、模拟请求(Mocking)1. 创建Mock Server2. 定义响应3. 使用Mock Server进行请求 七、API监控1. 创建监控2. 运行监控 一、创建测试集…

DBAPI连接阿里云 maxcompute 报错

使用正确的驱动包 访问以下链接寻找驱动包 https://github.com/aliyun/aliyun-odps-jdbc/releases/tag/v3.4.3 注意要使用odps-jdbc-3.4.3-jar-with-dependencies.jar ,这个是完整的jar包 不要使用odps-jdbc-3.4.3.jar,这个不是完整的,它还…

如何产看SQL 查询的执行时间

要查看 SQL 查询的执行时间,尤其是毫秒级别,可以使用以下几种方法: 方法 1:使用 SET STATISTICS TIME 查看执行时间 SET STATISTICS TIME 会显示执行时间的详细信息,包括 CPU 时间和总耗时。启用后,SQL S…

css | padding vs margin

前置知识 height是作用域内容(content)区域的 padding和margin用百分比的时候是怎么算的?父元素的宽度。注意,不是根据父元素相应的属性,就是父亲的width 自身的height是0 以下代码,外面盒子是100x10的,里面的widt…

433、315通信、ev1527、2262编码

目录 ASK介绍EV1527编码芯片介绍模块介绍无线发射芯片无线接收芯片解码程序发射电路原理图 ASK介绍 ASK是幅移键控,通过调幅将数据发送出去,所以发送与接收都是多位二进制数。 ASK如何区分0和1? 0:发送 433.92Mhz 无线波形&…

掌握ElasticSearch(八):聚集、文档间的关系

文章目录 一、聚集聚集类型示例 二、文档间的关系1. 对象类型(Object Type)2. 嵌套文档(Nested Documents)定义嵌套字段索引嵌套文档查询嵌套文档 3. 父子关系(Parent-Child Relationship)定义父子关系索引…