|
379 | 379 | "ID_if_tooManyElseIf": { |
380 | 380 | "checkPoint": "if...else-if 分枝数量应在规定范围之内", |
381 | 381 | "level": "warning", |
382 | | - "comment": "if...else-if 分枝过多不利于维护,而且执行时各分枝的条件需逐一判断,效率较低,建议改为遵循某种算法的索引结构。", |
| 382 | + "comment": "if...else-if 分枝过多不利于阅读和维护,而且执行时需逐一判断各分枝的条件,效率较低,建议改为遵循某种算法的索引结构。", |
383 | 383 | "config": [ |
384 | 384 | "maxElseIfCount: 分枝数量上限,超过则报出" |
385 | 385 | ], |
|
445 | 445 | "ID_switch_tooManyCases": { |
446 | 446 | "checkPoint": "switch 语句分枝数量应在规定范围之内", |
447 | 447 | "level": "warning", |
448 | | - "comment": "switch 语句分枝过多会使代码过于庞大不利于维护,分枝很多时建议将每个 case 的执行逻辑抽取成函数,再按遵循某种算法的索引结构组织在一起。", |
| 448 | + "comment": "switch 语句分枝过多不利于阅读和维护,这种情况下建议将分枝抽取成函数,再按遵循某种算法的索引结构组织在一起。", |
449 | 449 | "config": [ |
450 | 450 | "maxCasesCount: 分枝数量上限,超过则报出" |
451 | 451 | ], |
|
462 | 462 | "ID_switch_forbidNest": { |
463 | 463 | "checkPoint": "switch 语句不应嵌套", |
464 | 464 | "level": "suggestion", |
465 | | - "comment": "嵌套的 switch 语句使代码显得复杂,不利于维护。", |
| 465 | + "comment": "嵌套的 switch 语句使代码显得复杂,不利于阅读和维护。", |
466 | 466 | "tag": "control" |
467 | 467 | }, |
468 | 468 | "ID_try_disorderedHandlers": { |
|
484 | 484 | "ID_try_forbidNest": { |
485 | 485 | "checkPoint": "不应嵌套 try-catch 语句", |
486 | 486 | "level": "suggestion", |
487 | | - "comment": "嵌套的 try-catch 使代码显得复杂,不利于维护。", |
| 487 | + "comment": "嵌套的 try-catch 语句使代码显得复杂,不利于阅读和维护。", |
488 | 488 | "tag": "control", |
489 | 489 | "reference": "C++ Core Guidelines E.17" |
490 | 490 | }, |
|
1076 | 1076 | "ID_forbidGoto": { |
1077 | 1077 | "checkPoint": "禁用 goto 语句", |
1078 | 1078 | "level": "suggestion", |
1079 | | - "comment": "历史表明,goto 语句会破坏程序的结构性规划,很容易导致逻辑混乱且不利于维护,在非自动生成的、对可读性有要求的代码中,建议禁用 goto 语句。", |
| 1079 | + "comment": "历史表明,goto 语句会破坏程序的结构性规划,很容易导致逻辑混乱且不利于阅读和维护,在非自动生成的、对可读性有要求的代码中,建议禁用 goto 语句。", |
1080 | 1080 | "tag": "control", |
1081 | 1081 | "related": "ID_forbidGotoBlocks,ID_forbidGotoBack", |
1082 | 1082 | "reference": "C++ Core Guidelines ES.76,MISRA C 2012 15.1" |
|
2765 | 2765 | "ID_functionRepetition": { |
2766 | 2766 | "checkPoint": "避免重复的函数实现", |
2767 | 2767 | "level": "suggestion", |
2768 | | - "comment": "重复的或过于相似的代码是不利于维护的。", |
| 2768 | + "comment": "重复的或过于相似的代码不利于维护。", |
2769 | 2769 | "tag": "function", |
2770 | 2770 | "config": [ |
2771 | 2771 | "tokenCountThreshold: 符号数量阈值,小于此阈值的函数不参与比较", |
|
3076 | 3076 | "ID_duplicatedTypeName": { |
3077 | 3077 | "checkPoint": "类型名称不应重复定义", |
3078 | 3078 | "level": "suggestion", |
3079 | | - "comment": "如果类型相关的名称有重复,极易引起误解,不利于维护。", |
| 3079 | + "comment": "如果类型相关的名称有重复,极易引起误解,不利于阅读和维护。", |
3080 | 3080 | "tag": "declaration", |
3081 | 3081 | "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" |
3082 | 3082 | }, |
|
0 commit comments