From 7d40d7d3280194a33a20fea48a9eb9a9cc5255ef Mon Sep 17 00:00:00 2001 From: Jonathan Lee Date: Thu, 11 Nov 2021 18:36:41 +0800 Subject: [PATCH 1/4] =?UTF-8?q?=E6=8B=86=E5=88=86=E5=B8=B8=E9=87=8FP?= =?UTF-8?q?=E8=A7=84=E5=88=99=EF=BC=8C=E7=A7=BB=E6=AD=A5P.CNS.01=E5=88=B0?= =?UTF-8?q?=E4=BB=A3=E7=A0=81=E9=A3=8E=E6=A0=BC=E4=B8=8B?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- src/safe-guides/coding_practice/consts.md | 77 ++++++++++++----------- 1 file changed, 39 insertions(+), 38 deletions(-) diff --git a/src/safe-guides/coding_practice/consts.md b/src/safe-guides/coding_practice/consts.md index e8bb4a87..a56fd36d 100644 --- a/src/safe-guides/coding_practice/consts.md +++ b/src/safe-guides/coding_practice/consts.md @@ -9,44 +9,6 @@ --- -## P.CNS.01 常量必须都要持有明确语义以便让人更好地理解 - -### 【描述】 - -常量的定义必须表达清楚相应语义，这样可以增强可读性。 - -【正例】 - -```rust -const ERROR_DIRECTORY_NOT_SUPPORTED: u32 = 336; -const ERROR_DRIVER_CANCEL_TIMEOUT: u32 = 594; -``` - -【反例】 - -```rust -const ERROR_NO_1: u32 = 336; -const ERROR_NO_2: u32 = 594; -``` - - - -## P.CNS.02 注意根据常量和静态变量的本质区别来选择何时使用常量或静态变量 - -### 【描述】 - -常量 vs 静态变量： - -1. 常量会内联到使用它的地方。 -2. 静态变量不会内联，它是全局的，且有一个引用地址。 - -有些场合要根据常量和静态变量的本质区别来选择合适的类型。 - -比如，当你想创建一个很大的常量数组时，应该考虑将其换成静态变量。因为常量会到处内联。 - ---- - - ## G.CNS.01 对于科学计算中涉及浮点数近似值的常量要尽量使用预定义常量 ### 【级别：建议】 @@ -232,3 +194,42 @@ fn new() -> Self { } ``` +## G.CNS.05 注意避免将量大的数据结构定义为常量 + +### 【级别：建议】 + +建议按此规范执行。 + +### 【Lint 检测】 + +| lint name | Clippy 可检测 | Rustc 可检测 | Lint Group | 是否可定制 | +| ------------------------------------------------------------ | ------------- | ------------ | ---------- | ----- | +| _ | no | no | _ | yes | + +【定制化参考】 +这条规则如果需要定制Lint，则需要找出每个定义的常量再判断其空间占用，或可直接排除基础类型以外的数据类型。 + +**【描述】** + +常量会内联到使用它的地方而静态变量不会内联，它是全局的，且有一个引用地址。 +当创建一个很大的常量数组时，应该考虑将其换成静态变量，因为常量会到处内联。 + + +**【示例】** +【正例】 +```rust +fn main() { + static MONTHS: [&str; 12] = ["January", "Feburary", "March", "April", + "May", "June", "July", "August", + "September", "October", "November", "December"]; +} +``` + +【反例】 +```rust +fn main() { + const MONTHS: [&str; 12] = ["January", "Feburary", "March", "April", + "May", "June", "July", "August", + "September", "October", "November", "December"]; +} +``` From f9dc95138d731bd5ac642095d56ab6cf7f9d8896 Mon Sep 17 00:00:00 2001 From: Jonathan Lee Date: Thu, 11 Nov 2021 18:46:21 +0800 Subject: [PATCH 2/4] =?UTF-8?q?=E5=B0=86=E5=B8=B8=E9=87=8F=E5=86=85?= =?UTF-8?q?=E7=9A=84=E5=91=BD=E5=90=8D=E8=A7=84=E8=8C=83=E8=9E=8D=E5=90=88?= =?UTF-8?q?=E5=88=B0=E4=BB=A3=E7=A0=81=E9=A3=8E=E6=A0=BC=E5=86=85=E7=9A=84?= =?UTF-8?q?=E5=91=BD=E5=90=8D=E4=B8=AD?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- src/safe-guides/code_style/naming.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/src/safe-guides/code_style/naming.md b/src/safe-guides/code_style/naming.md index 9f1bf2fa..428ffb07 100644 --- a/src/safe-guides/code_style/naming.md +++ b/src/safe-guides/code_style/naming.md @@ -17,6 +17,24 @@ - 布尔型变量或函数避免使用否定形式 - 尽量不要使用 Unicode 标识符。 +【正例】 + +```rust +let first_name: &str = "John"; +let last_name: &str = "Smith"; +const ERROR_DIRECTORY_NOT_SUPPORTED: u32 = 336; +const ERROR_DRIVER_CANCEL_TIMEOUT: u32 = 594; +``` + +【反例】 + +```rust +let ming: &str = "John"; +let xing: &str = "Smith"; +const ERROR_NO_1: u32 = 336; +const ERROR_NO_2: u32 = 594; +``` + ## P.NAM.02 避免使用语言内置保留字、关键字、内置类型和`trait`等特殊名称 From 543f787aabffb226e7c40d395ce7a569a7ecad9d Mon Sep 17 00:00:00 2001 From: Jonathan Lee Date: Thu, 11 Nov 2021 19:08:19 +0800 Subject: [PATCH 3/4] =?UTF-8?q?=E5=B0=86=E9=9D=99=E6=80=81=E5=8F=98?= =?UTF-8?q?=E9=87=8FP=E8=A7=84=E5=88=99=E6=94=B9=E4=B8=BAG=E8=A7=84?= =?UTF-8?q?=E5=88=99=E5=B9=B6=E6=B7=BB=E5=8A=A0lint=E5=BB=BA=E8=AE=AE?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- src/safe-guides/coding_practice/statics.md | 30 +++++++++++++++++++--- 1 file changed, 27 insertions(+), 3 deletions(-) diff --git a/src/safe-guides/coding_practice/statics.md b/src/safe-guides/coding_practice/statics.md index 8df949bf..cf608c7c 100644 --- a/src/safe-guides/coding_practice/statics.md +++ b/src/safe-guides/coding_practice/statics.md @@ -3,13 +3,38 @@ --- -## P.STV.01 不要直接使用可变静态变量作为全局变量 +## G.STV.01 不要直接使用可变静态变量作为全局变量 + +### 【级别：建议】 + +建议按此规范执行。 + +### 【Lint 检测】 + +| lint name | Clippy 可检测 | Rustc 可检测 | Lint Group | 是否可定制 | +| ------------------------------------------------------------ | ------------- | ------------ | ---------- | ----- | +| _ | no | no | _ | yes | + +【定制化参考】 +这条规则如果需要定制Lint，则可以先检查代码是否使用到FFI，然后再检测代码中是否有已定义为可变的静态变量（static mut），以及其是否用在用于调用外部函数上，若此条件不达标则发出告警。 ### 【描述】 对可变静态变量进行全局修改是 Unsafe 的。在多线程应用中，修改静态变量会导致数据争用（data race），此未定义行为目前并不会被Clippy或Rustc检测出。 -### +【反例】 + +```rust +static mut NUM_OF_APPLES: i32 = 0; + +unsafe fn buy_apple() { + NUM_OF_APPLES += 1; +} + +unsafe fn eat_apple() { + NUM_OF_APPLES -= 1; +} +``` 【例外】 @@ -36,4 +61,3 @@ fn main() { } ``` - From f075ba03dd048fc36aedc034960f08c9239ce85e Mon Sep 17 00:00:00 2001 From: Jonathan Lee Date: Thu, 11 Nov 2021 19:15:45 +0800 Subject: [PATCH 4/4] =?UTF-8?q?=E4=BF=AE=E6=AD=A3=E7=BC=96=E5=8F=B7?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- src/safe-guides/coding_practice/consts.md | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/src/safe-guides/coding_practice/consts.md b/src/safe-guides/coding_practice/consts.md index a56fd36d..309cf578 100644 --- a/src/safe-guides/coding_practice/consts.md +++ b/src/safe-guides/coding_practice/consts.md @@ -161,9 +161,6 @@ static FOO: &'static [(&'static str, &'static str, fn(&Bar) -> bool)] = ``` - - - ## G.CNS.05 对于函数或方法应尽可能地使用 `const fn` ### 【级别：建议】 @@ -194,7 +191,7 @@ fn new() -> Self { } ``` -## G.CNS.05 注意避免将量大的数据结构定义为常量 +## G.CNS.06 注意避免将量大的数据结构定义为常量 ### 【级别：建议】