Rust 中的注释

Rust 中的注释分为两种:

普通注释

Rust 的普通注释与 C++ 的风格一样,分为:

示例

fn main() {
    // 这是行注释

    /* 这是块注释,
    可以注释多行。*/

    /*
     * 这也是块注释
     * 该行前面的星号不是必须的
     * 但这样比较好看
     */

    /* 块注释可以嵌套 /* 嵌套有什么用? */ 我很疑惑 */

    // 块注释可以注释掉一行中间的部分代码,行注释则没有这个能力
    let x = 5 + /* 90 + */ 5;
    println!("Is `x` 10 or 100? x = {}", x);
}

文档注释

文档注释也分为单行注释和块注释,但又有内外之分:

二者的区别:

另外,在文档注释中可以使用 Markdown 语法。

示例:
使用 cargo new comment --lib 创建一个项目,将下面的代码 src/lib.rs 是文件中的内容。

//! # Comment
//! 外部文档注释--描述包含它的项,一般用来编写 Crate 的文档注释。

/// - 内部文档注释 -- `outer_module` 的单行注释1
/** - 内部文档注释 -- `outer_module` 的块注释1 */
pub mod outer_module {

    //! - 外部文档注释 -- `outer_module` 的单行注释2
    /*! - 外部文档注释 -- `outer_module` 的块注释2 */

    /// - 内部文档注释 -- `inner_module` 的单行注释
    /** - 内部文档注释 -- `inner_module` 的块注释 */
    pub mod inner_module {}

    /// 这是代表人类一个结构体
    pub struct Person {
        /// 一个人必须有名字
        name: String,
    }

    impl Person {
        /// 返回具有指定名字的一个人
        ///
        /// # 参数
        ///
        /// * `name` - 字符串切片,代表人的名字
        ///
        /// # 示例
        ///
        /// ```
        /// // 在文档注释中,可以编写代码块
        /// // 如果向 Rustdoc 传递 --test 参数,它还会帮你测试注释文档中的代码!
        /// use comment::Person;
        /// let person = Person::new("name");
        /// ```
        pub fn new(name: &str) -> Person {
            Person {
                name: name.to_string(),
            }
        }
    }
}

使用 cargo doc 命令可以生成 Rust 项目的 HTML 帮助文档,上面的示例生成的文档如下图所示:

comment Crate 的文档
comment

outer_module 模块的文档
outer_module

Person 结构体的文档
Person

相关资料

The Rust Reference

The rustdoc book

Rust By Example

  • Rust

    Rust 是一门赋予每个人构建可靠且高效软件能力的语言。Rust 由 Mozilla 开发,最早发布于 2014 年 9 月。

    29 引用 • 13 回帖 • 2 关注

广告 我要投放

欢迎来到这里!

我们正在构建一个小众社区,大家在这里相互信任,以平等 • 自由 • 奔放的价值观进行分享交流。最终,希望大家能够找到与自己志同道合的伙伴,共同成长。

注册 关于
请输入回帖内容 ...
  • yp

    博客端点击进去访问不了