3.2 文档

02-文档 — Comprehensive Rust

  1分钟内可阅读完  

译文 · 基于 Comprehensive Rust

原文链接: https://google.github.io/comprehensive-rust/std-types/docs.html

3.2 文档

Rust 自带详尽文档。例如：

用 rustup doc --std 或 https://std.rs 查看文档。

实际上，你也可以为自己的代码写文档：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

// Copyright 2023 Google LLC
// SPDX-License-Identifier: Apache-2.0
/// 判断第一个参数是否能被第二个参数整除。
///
/// 若第二个参数为零，结果为 false。
fn is_divisible_by(lhs: u32, rhs: u32) -> bool {
    if rhs == 0 {
        return false;
    }
    lhs % rhs == 0
}

内容按 Markdown 处理。所有已发布的 Rust 库 crate 都会通过 rustdoc 工具自动在 docs.rs 上生成文档。惯用做法是用这种模式为 API 中所有公开项写文档。

要从项内部（例如模块内部）为该项写文档，使用 //! 或 /*! .. */，称为「内部文档注释」：

1
2
3

// Copyright 2023 Google LLC
// SPDX-License-Identifier: Apache-2.0
//! 本模块包含与整数整除相关的功能。
最后修改 August 11, 2026: 更新 (70a5af133)