Skip to content

Commit 3126c1c

Browse files
authored
优化格式
优化配置选项格式,精炼词句
1 parent 4ee4067 commit 3126c1c

File tree

2 files changed

+87
-85
lines changed

2 files changed

+87
-85
lines changed

c-cpp-rules.json

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -379,7 +379,7 @@
379379
"ID_if_tooManyElseIf": {
380380
"checkPoint": "if...else-if 分枝数量应在规定范围之内",
381381
"level": "warning",
382-
"comment": "if...else-if 分枝过多不利于维护,而且执行时各分枝的条件需逐一判断,效率较低,建议改为遵循某种算法的索引结构。",
382+
"comment": "if...else-if 分枝过多不利于阅读和维护,而且执行时需逐一判断各分枝的条件,效率较低,建议改为遵循某种算法的索引结构。",
383383
"config": [
384384
"maxElseIfCount: 分枝数量上限,超过则报出"
385385
],
@@ -445,7 +445,7 @@
445445
"ID_switch_tooManyCases": {
446446
"checkPoint": "switch 语句分枝数量应在规定范围之内",
447447
"level": "warning",
448-
"comment": "switch 语句分枝过多会使代码过于庞大不利于维护,分枝很多时建议将每个 case 的执行逻辑抽取成函数,再按遵循某种算法的索引结构组织在一起。",
448+
"comment": "switch 语句分枝过多不利于阅读和维护,这种情况下建议将分枝抽取成函数,再按遵循某种算法的索引结构组织在一起。",
449449
"config": [
450450
"maxCasesCount: 分枝数量上限,超过则报出"
451451
],
@@ -462,7 +462,7 @@
462462
"ID_switch_forbidNest": {
463463
"checkPoint": "switch 语句不应嵌套",
464464
"level": "suggestion",
465-
"comment": "嵌套的 switch 语句使代码显得复杂,不利于维护",
465+
"comment": "嵌套的 switch 语句使代码显得复杂,不利于阅读和维护",
466466
"tag": "control"
467467
},
468468
"ID_try_disorderedHandlers": {
@@ -484,7 +484,7 @@
484484
"ID_try_forbidNest": {
485485
"checkPoint": "不应嵌套 try-catch 语句",
486486
"level": "suggestion",
487-
"comment": "嵌套的 try-catch 使代码显得复杂,不利于维护",
487+
"comment": "嵌套的 try-catch 语句使代码显得复杂,不利于阅读和维护",
488488
"tag": "control",
489489
"reference": "C++ Core Guidelines E.17"
490490
},
@@ -1076,7 +1076,7 @@
10761076
"ID_forbidGoto": {
10771077
"checkPoint": "禁用 goto 语句",
10781078
"level": "suggestion",
1079-
"comment": "历史表明,goto 语句会破坏程序的结构性规划,很容易导致逻辑混乱且不利于维护,在非自动生成的、对可读性有要求的代码中,建议禁用 goto 语句。",
1079+
"comment": "历史表明,goto 语句会破坏程序的结构性规划,很容易导致逻辑混乱且不利于阅读和维护,在非自动生成的、对可读性有要求的代码中,建议禁用 goto 语句。",
10801080
"tag": "control",
10811081
"related": "ID_forbidGotoBlocks,ID_forbidGotoBack",
10821082
"reference": "C++ Core Guidelines ES.76,MISRA C 2012 15.1"
@@ -2765,7 +2765,7 @@
27652765
"ID_functionRepetition": {
27662766
"checkPoint": "避免重复的函数实现",
27672767
"level": "suggestion",
2768-
"comment": "重复的或过于相似的代码是不利于维护的",
2768+
"comment": "重复的或过于相似的代码不利于维护",
27692769
"tag": "function",
27702770
"config": [
27712771
"tokenCountThreshold: 符号数量阈值,小于此阈值的函数不参与比较",
@@ -3076,7 +3076,7 @@
30763076
"ID_duplicatedTypeName": {
30773077
"checkPoint": "类型名称不应重复定义",
30783078
"level": "suggestion",
3079-
"comment": "如果类型相关的名称有重复,极易引起误解,不利于维护",
3079+
"comment": "如果类型相关的名称有重复,极易引起误解,不利于阅读和维护",
30803080
"tag": "declaration",
30813081
"reference": "MISRA C 2004 5.3,MISRA C 2004 5.4,MISRA C 2012 5.6,MISRA C 2012 5.7,MISRA C++ 2008 2-10-3,MISRA C++ 2008 2-10-4"
30823082
},

0 commit comments

Comments
 (0)