【编码规范】VS中设置 及 注意事项

目录

（一）Visual Studio简化编码设置

1、设置 & 和 * 前后留一个空格：

2、简化注释配置VS：

（二）编码规范注意事项

1、内存使用：

2、指针使用：

3、越界访问：

4、变量、常量

5、文件处理

6、异常处理

7、表达式

8、排版

---

（一）Visual Studio简化编码设置

1、如何设置 & 和 * 前后留一个空格：

Tools（工具）-> Options（选项）->Text Editor（文本编辑器）->C/C++

  ->Formatting（格式设置）->Spacing（间距）->Spacing for operators（运算符的间距）

  ->Pointer/refrence alignment（指针/引用对齐方式）->设置为Align center（居中对齐）

【注意】：格式化代码操作的快捷键为：Ctrl+k, Ctrl+f

2、简化注释配置VS：

使用 doxygen 工具帮助生成注释模板。

（1）在VS中配置：

Tools（工具）-> Options（选项）->Environment（环境）->Fonts and Colors（字体和颜色）

  ->Display items（显示项）中找到XML Doc Document（XML文档注释）

  ->设置Item foreground（项前景）的Custom（自定义）选择颜色。

（2）这样设置后：

在文件首输入 //- 后就会自动生成指定的注释模板。

在函数声明前一行输入 /// 后回车自动生成函数注释模板。

【补充】插件不唯一，还有许多其他的插件。

（二）编码规范注意事项

1、内存使用：

  1）malloc / free 和 new / delete 不要混淆使用；

  2）函数退出时，尤其是异常分支退出时，释放申请的内存；不要重复释放内存；

  3）尽量不设计跨函数释放内存，尽量做到“谁申请，谁释放“；

2、指针使用：

  1）对指针参数进行合法性检查；指针合法性检查后，注意流程处理的正确性；

  2）注意指针的偏移计算；

  3）不要使用 空指针、已释放的指针；

3、越界访问：

  1）字符串拷贝要注意保证字符串长度的合法性；不要存在不同数据类型的赋值和比较；

  2）注意字符串初始化、拷贝等操作的入参的正确性；

  3）比较时，考虑精度问题；

4、变量、常量

  1）注意变量的初始化和缺省值的准确性；

  2）不用 const常量 取代 宏常量；

  3）类名、函数名、变量、常量、参数的书写格式要简析明了；不用无意义的魔鬼数字；静态变量、全局变量、类的成员变量可以添加前缀；

5、文件处理

  1）不存在或者错误的文件操作；

  2）注意文件打开和关闭的方式的正确性；打开的文件使用完后要关闭。

6、异常处理

  1）考虑异常处理流程；

  2）注意异常处理是否可能会被执行；避免已经触发异常了，再执行异常处理程序（避免马后炮）

  3）注意异常处理流程的错误与实际的错误的区别与处理；

7、表达式

  1）运算符较多时，用括号来明晰优先级；尽量避免编写太复杂或多用途的复合表达式；

  2）switch语句需要有default语句；case语句的结尾需要有break；

  3）循环内存在逻辑判断 且 循环次数较大时，考虑将逻辑判断移到循环的外面；

  4）循环终止：① 循环终止条件是否正确，② 循环是否能正常终止，避免死循环；

8、排版

  1）一行 ≥ 80个字符 的代码考虑拆分，并注意拆分的得体性；

  2）if / for / while / do 等语句各占一行，并严格使用 {} 括起来；

  3）注释要清晰必要；注意空行的书写；减少无效代码和冗余代码。