Rust 编码规范 V 1.0 beta

G.CMT.03 在文档注释中要使用空格代替 tab

【级别】 建议

【描述】

Rust 代码风格中提倡使用四个空格代替tab，在文档注释中也应该统一使用四个空格。

【反例】

下面文档注释中使用了 tab。

#![allow(unused)]
fn main() {
// 不符合：文档注释中使用了 tab 缩进
///
/// Struct to hold two strings:
/// 	- first		one
/// 	- second	one
pub struct DoubleString {
   ///
   /// 	- First String:
   /// 		- needs to be inside here
   first_string: String,
   ///
   /// 	- Second String:
   /// 		- needs to be inside here
   second_string: String,
}
}

【正例】

#![allow(unused)]
fn main() {
// 符合：文档注释中使用了四个空格缩进
///
/// Struct to hold two strings:
///     - first        one
///     - second    one
pub struct DoubleString {
   ///
   ///     - First String:
   ///         - needs to be inside here
   first_string: String,
   ///
   ///     - Second String:
   ///         - needs to be inside here
   second_string: String,
}
}

【Lint 检测】