Rust 编程 | 注释教程

简介

在本实验中，我们将了解 Rust 支持的不同类型的注释，包括常规注释和文档注释。常规注释可以是行注释，以两个斜杠开头并延续到行尾，也可以是块注释，用 /* 和 */ 括起来并且可以嵌套。另一方面，文档注释用于生成 HTML 库文档，以 /// 或 //! 开头。

注意：如果实验未指定文件名，你可以使用任何你想要的文件名。例如，你可以使用 main.rs，通过 rustc main.rs &&./main 进行编译和运行。

Skills Graph

%%%%{init: {'theme':'neutral'}}%%%% flowchart RL rust(("Rust")) -.-> rust/ErrorHandlingandDebuggingGroup(["Error Handling and Debugging"]) rust(("Rust")) -.-> rust/BasicConceptsGroup(["Basic Concepts"]) rust(("Rust")) -.-> rust/FunctionsandClosuresGroup(["Functions and Closures"]) rust(("Rust")) -.-> rust/MemorySafetyandManagementGroup(["Memory Safety and Management"]) rust/BasicConceptsGroup -.-> rust/variable_declarations("Variable Declarations") rust/FunctionsandClosuresGroup -.-> rust/function_syntax("Function Syntax") rust/FunctionsandClosuresGroup -.-> rust/expressions_statements("Expressions and Statements") rust/MemorySafetyandManagementGroup -.-> rust/lifetime_specifiers("Lifetime Specifiers") rust/ErrorHandlingandDebuggingGroup -.-> rust/error_propagation("Error Propagation") subgraph Lab Skills rust/variable_declarations -.-> lab-99185{{"Rust 注释类型与文档"}} rust/function_syntax -.-> lab-99185{{"Rust 注释类型与文档"}} rust/expressions_statements -.-> lab-99185{{"Rust 注释类型与文档"}} rust/lifetime_specifiers -.-> lab-99185{{"Rust 注释类型与文档"}} rust/error_propagation -.-> lab-99185{{"Rust 注释类型与文档"}} end

注释

任何程序都需要注释，Rust 支持几种不同类型的注释：

常规注释：会被编译器忽略：
- // 行注释，延续到行尾。
- /* 块注释，延续到结束分隔符。 */
文档注释：会被解析为 HTML 库文档：
- /// 为后续项生成库文档。
- //! 为包含它的项生成库文档。

fn main() {
    // 这是一个行注释的示例。
    // 行首有两个斜杠。
    // 该行斜杠之后的内容不会被编译器读取。

    // println!("Hello, world!");

    // 运行它。看到了吧？现在试着删除这两个斜杠，然后再运行一次。

    /*
     * 这是另一种注释类型，块注释。一般来说，
     * 行注释是推荐的注释风格。但块注释
     * 对于临时禁用代码块非常有用。
     * /* 块注释可以 /* 嵌套， */ */ 所以只需敲几下键
     * 就能注释掉 main() 函数中的所有内容。
     * /*/*/* 自己试试看！ */*/*/
     */

    /*
    注意：前面一列的 `*` 完全是为了美观。实际上并不需要。
    */

    // 与行注释相比，使用块注释操作表达式更容易
    // 试试删除注释分隔符来改变结果：
    let x = 5 + /* 90 + */ 5;
    println!("`x` 是 10 还是 100？x = {}", x);
}

总结

恭喜你！你已经完成了“注释”实验。你可以在 LabEx 中练习更多实验来提升你的技能。