Skip to content

PeterWrighten/rust-coding-guidelines

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

36 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Rust Coding Guidelines

《Rust 编码规范》 中文版

WIP.See the Chinese version for the full version, the English version is currently being translated from the Chinese version, welcome to participate in the contribution!

Introduce

It is understood that some companies and organizations within the Rust community maintain their own coding specifications. Some of the publicly available ones are listed below.

The role of coding specifications

  1. Improve the readability, maintainability, robustness, and portability of code by following Rust language features.
  2. Improve the standardization and security of Unsafe Rust code writing.
  3. The programming specification terms strive to systematize, easy to apply, easy to check, to help developers improve development efficiency.
  4. give developers a clear and global vision, in the process of developing code can follow a good code specification, rather than wait until the code is written and then through rustfmt and clippy such tools, a line to modify the warning.
  5. The specification is not a tutorial, but the level of developers varies. For some knowledge blind spots and those that may lead to program errors, the specification will also cover.

Releases

No releases published

Packages

No packages published