使用 `rustdoc` 编写文档

RustDoc 是 Rust 生态系统中的一个宝贵工具，可以直接从您的源代码生成全面且用户友好的文档。通过利用特殊的文档注释（以 /// 开头用于常规注释，以 //! 开头用于 crate 级注释），开发者可以将 Markdown 格式的文本、代码示例甚至 doctests 直接嵌入到他们的函数、模块和类型旁边。RustDoc 然后处理这些注释以生成静态 HTML 页面，使其他人（以及未来的您）能够轻松理解如何使用您的库和应用程序。这种集成方法不仅促进了良好的文档习惯，还确保了文档与代码库保持同步。