rust 语法和语义 05 注释

最新推荐文章于 2024-04-20 22:11:49 发布

mint_ying

最新推荐文章于 2024-04-20 22:11:49 发布

阅读量344

点赞数

CC 4.0 BY-SA版权

分类专栏： rust 文章标签： rust comments

本文链接：https://blog.youkuaiyun.com/mint_ying/article/details/79406846

rust 专栏收录该内容

15 篇文章

订阅专栏

本文详细介绍了Rust语言中的注释用法，包括行注释、整段注释及文档注释的不同形式，并展示了如何使用文档注释进行代码文档的自动生成。

rust 语法和语义 05 注释

注释：comments

rust的注释主要分为两类：行注释 line comments 和 文档注释 doc comments 。

行注释 line comments

同 c 一样，使用 // 开头。

// 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.

整段注释

同 c 一样，使用 /* */ 表示。

/*
this is block comments,
you can put line comments next to each other.
 */

文档注释 doc comments

使用 /// 表示文档注释。并内建 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
/// # }
/// ```
fn add_one(x: i32) -> i32 {
    x + 1
}

包含项注释

使用 //! 注释那些包含这个注释的 crate，mod，或者function。而不是位于注释以后的内容。

经常用于 crate的根文件 lib.rs 或者 模块的根文件 mod.rs 。

//! # The Rust Standard Library
//!
//! The Rust Standard Library provides the essential runtime
//! functionality for building portable Rust software