chens08 / rust-coding-guidelines-zh

Rust 编码规范 中文版 （非官方）

Rust 编码规范 中文版

状态

• 《Rust 编码规范》目前为 V 1.0 beta 试行版，改进内容参考 Changelog

介绍

据了解，Rust 社区内有些公司和组织都各自维护着自己的编码规范。下面罗列了一些已经公开的：

• 官方｜Rust API 编写指南
• 官方 | Rust Style Guide
• Rust's Unsafe Code Guidelines Reference
• 法国国家信息安全局 | Rust 安全（Security）规范
• Facebook Diem 项目 Rust 编码规范(已过期)
• Apache Teaclave 安全计算平台 | Rust 开发规范
• PingCAP | 编码风格指南（包括 Rust 和 Go 等）
• Google Fuchsia 操作系统 Rust 开发指南
• RustAnalyzer 编码风格指南
• 使用 Rust 设计优雅的 API
• Rust FFI 指南
• 大约 478 条 Clippy lint
• lints in the rustc book
• Dtolnay 对 crates.io 中 clippy lint 应用统计

但是随着 Rust 日益普及，统一的编码规范需求也逐渐浮出水面，本规范应运而生。

本规范致力于成为统一的 Rust 编码规范，并联合国内外公司共同维护。

公司可以依赖本规范，结合自己的业务领域和团队习惯，形成自己的编码规范，并可以在日常实践中反哺本规范，让本规范更加完善。