一直以为,在一个team或者一个公司里,代码规范是一件很重要的事情,大家都遵循一个规则,这既能减少不必要的沟通,节省时间,养成个人的良好习惯等等。如果是一个开源项目,良好的代码规范和API设计,直白且易用,减少开发者的熟悉时间等等。

而由于Rust语言的特殊性,比如所有权,trait等的一些特性,所以很有必要有一套Rust的编程规范,所以官方就编写了一些文档关于规范Rust编程的。

但由于是英文的,所以看起来有时候并不直白,我就花时间翻译了中文版。英文水平有限,翻译得一般,有错误尽管提出。

目前还处在翻译中。

Rust API Guidelines的章节

关于(About)

清单(Checklist)

命名规范(Naming)

互操作性规范(Interoperability)

宏规范(Macros)

文档(Documentation)

可预见性规范(Predictability)

灵活性规范(Flexibility)

类型安全规范(Type safety)

依赖性规范(Dependability)

调试性规范(Debuggability)

防护性规范(Future proofing)

必要性规范(Necessities)

外部链接