2.2 格式

制定统一的编码风格,是为了提升代码的可读性,让日常代码维护和团队之间审查代码更加方便。

Rust 有自动化格式化工具 rustfmt ,可以帮助开发者摆脱手工调整代码格式的工作,提升生产力。但是,rustfmt 遵循什么样的风格规范,作为开发者需要了解,在编写代码的时候可以主动按这样的风格编写。

说明:

对于 rustfmt 中未稳定的配置项(StableNo),则表示该配置项不能在稳定版(Stable)Rust 中更改配置,但其默认值会在cargo fmt时生效。在 Nightly Rust 下则都可以自定义配置。

如需了解在稳定版 Rust 中使用未稳定配置项的方法、配置示例及其他全局配置项说明,请参阅:Rustfmt 配置相关说明

【注意事项】

因为 rustfmt 工具会自动修改代码,为了确保 rustfmt 不会因为意外而改错代码,所以在使用 rustfmt 时应该注意下面两项描述:

  1. 务必保证在全部把代码修改完毕且编译通过之后再执行 rustfmt 命令。 因为 rustfmt 执行过程中不会对代码进行编译,所以就不会有静态检查保护。
  2. 如果是使用 IDE 或 编辑器的时候开启了自动保护功能,就不要开启自动执行 rustfmt 功能。