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

文章目录


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 格式的说明文档。

相关推荐
CodeCraft Studio6 小时前
Excel处理控件Aspose.Cells教程:使用 C# 从 Excel 进行邮件合并
开发语言·c#·excel
小超爱编程6 小时前
纯前端做图片压缩
开发语言·前端·javascript
KIDAKN9 小时前
java--怎么定义枚举类
java·开发语言
海天胜景9 小时前
C# 中常用的 字符串截取方法
开发语言·c#
tkevinjd10 小时前
C++中线程库的基本操作
开发语言·c++
CodeWithMe10 小时前
【C/C++】不同防止头文件重复包含的措施
c语言·开发语言·c++
子豪-中国机器人10 小时前
C++ 信息学奥赛总复习题答案解析
开发语言·c++·算法
oioihoii10 小时前
C++11列表初始化:从入门到精通
java·开发语言·c++
zdy126357468810 小时前
python第48天打卡
开发语言·python
whoarethenext11 小时前
使用 C++/OpenCV 创建动态流星雨特效 (实时动画)
开发语言·c++·opencv