代码编写时的规范和注意事项

“干净的代码既简单又直接。干净的代码读起来像写得很好的散文。简洁的代码永远不会掩盖设计者的意图，而是充满清晰的抽象和直接的控制线。”                                                                                                                                               ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~                                                                                                                                              —罗伯特·马丁（Robert C. Martin）

1.为什么要遵循编码规范

1. 一致性：遵循编码规范可以确保整个项目中的代码风格和命名一致，这有助于使代码易于阅读和理解。

2. 可读性：良好的编码规范可以使代码易于阅读和理解，尤其是当有多个开发人员在同一项目上工作时。（在ACM这类团队比赛中极为重要）

3. 可维护性：遵循编码规范可以使代码易于维护。通过保持代码的一致性和易读性，开发人员可以更轻松地进行修改、调试和重构。

4. 代码质量：遵循编码规范可以提高代码的质量，减少错误和缺陷的数量。这可以节省时间和成本，因为需要更少的时间来修复错误和缺陷。

5. 团队合作：遵循编码规范可以促进团队合作和交流。所有开发人员都可以遵循相同的规范，这有助于避免由于代码差异而导致的冲突和混乱。

2. 高内聚 ，低耦合

何为高内聚 ，低耦合

高内聚，低耦合’是相对于代码而言，一个项目中：

每个模块之间相互联系的紧密程度，模块之间联系越紧密，则耦合性越高，模块的独立性就越差！反之同理；

一个模块中各个元素之间的联系的紧密程度，如果各个元素（语句、程序段）之间的联系程度越高，则内聚性越高，即‘高内聚’ ！

如果一个函数修改了，其他的函数都要修改，就说明这个程序是高耦合，独立性差

如何改善

1.避免创建大函数

如果一个函数实现的内容很多，可以考虑将其拆分为多个小函数，比如可以将检查数据范围的部分单独写成一个check函数，将输入和主程序之间分开

2.提高代码重用率

将实现相同任务的代码段选择封装成一个函数，如果有多重循环，就可以将所有循环提取到单独的函数中

这样一来代码重复性更小，更易于阅读、重用性高

3.命名规则

常量值所有都大写

常量命名都使用全大写的名称，并用下划线分割所有单词

const int price = 15;

变量命名

名称以小写字母开头，之后的每一个单词首字母都用大写，比如骆驼的大小写为camelCase
避免变量使用单个字母，要能够让代码更加通俗易懂（在循环里可以忽略这一点）

函数命名

函数的命名基本与上述提到的变量命名规则基本一样，但需要注意的是，命名尽量注意详细，要尽量将命名具体化

错误的示范：get

正确的示范：getUserInfo

4.一些其他事项

1.添加注释

对于一个程序员来说，敲代码的时间只占了百分之二十，其他百分之八十的时间都是后期的维护，这就是著名的 二八定律
所以在最初编写程序时添加相应的注释是十分必要的，现在节约的这一点时间未来将会花费更多的时间去弥补

2.禁用意义不明确的数字

cout << n * 15 << endl;

更好的方式：

int price = 15;
cout << n * price << endl;

这样就能很清楚的明白这个15指的是价格

从长远来看，遵循代码编写规范，对开发者的自身发展来说是百利而无一害的