使用 `rustdoc` 编写文档

RustDoc 是 Rust 生态中一个非常有价值的工具，它可以直接从源代码生成详尽且用户友好的文档。通过使用特殊的文档注释（普通注释以 `///` 开头，crate 级注释以 `//!` 开头），开发者可以在函数、模块和类型旁边直接嵌入 Markdown 格式文本、代码示例，甚至 doctest。然后 RustDoc 会处理这些注释，生成静态 HTML 页面，让其他人（以及未来的你）能够轻松理解如何使用你的库和应用程序。这种集成方式不仅培养了良好的文档习惯，还确保了文档与代码库保持同步。