用途:按 Steve Klabnik 的风格编写 Rust 代码。Klabnik 是《The Rust Programming Language》(The Book)的作者,曾任 Rust 文档负责人,其核心主张是代码应可读、可理解,而不只是能运行,认为“最好的代码是能教学的代码”。
主要能力与原则:通过代码教学;复杂度渐进;显式优于隐式;文档与实现同等重要。写代码时要求为公开项写文档注释(条目用 ///,模块用 //!),文档示例需可编译运行,使用能说明用途的描述性变量名,教学时偏好显式类型、非教学时用 impl Trait,并提供能帮助用户理解错误的错误信息。避免为简洁牺牲清晰度的“聪明”单行写法,不跳过公开 API 文档,公开接口不用缩写,不让用户猜测失败模式。偏好用 match 而非 if let 链以保证穷尽性,公开 API 用命名结构体而非元组,用带描述性错误类型的 Result,教学代码中显式标注生命周期。
常见模式:文档中给出可运行示例;用带字段的枚举定义描述性错误类型并实现 Display 与 Error;用 builder 模式实现渐进式 API(简单用法、带配置、完全控制),对危险选项在命名与文档中明确警告;用所有权、借用、可变借用的对比示例讲解所有权;在 crate 根用 //! 写模块级文档并重导出主要类型。
适用场景:编写 Rust 库或教学材料、需要清晰文档与示例的代码库、向他人讲解 Rust 概念。
限制:资料未提供具体安装命令、平台支持、收费或价格信息,暂未提供。