Rust 编码规范 V 1.0 beta

P.CMT.02 注释应该有宽度限制

【描述】

每行注释的宽度不能过长，需要设置一定的宽度，不超过120，有助于提升可读性。

rustfmt中通过comment_width配合 wrap_comments 配置项，可将超过宽度限制的注释自动分割为多行。

注意：rustfmt的 use_small_heuristics配置项并不包括comment_width。

【反例】

#![allow(unused)]
fn main() {
// 不符合
// Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
}

【正例】

当 comment_width=80 且 wrap_comments=true时。

注意：这里 wrap_comments并未使用默认值，需要配置为 true。

#![allow(unused)]
fn main() {
// 符合
// Lorem ipsum dolor sit amet, consectetur adipiscing elit,
// sed do eiusmod tempor incididunt ut labore et dolore
// magna aliqua. Ut enim ad minim veniam, quis nostrud
// exercitation ullamco laboris nisi ut aliquip ex ea
// commodo consequat.
}

【rustfmt 配置】