编码规范

编码培训

1.编码规范

1. 宁可1条能够落地执行的规范，也不要10页高大上难于落地的规范。
2. 要求：可读性高
3. 为什么要学习编码规范？
   • 为了缩短开发时间
   • 为了便于维护
   • 为了编写零漏洞的完美程序
4. 程序员写代码要保证软件质量。

2.格式类编码规范

1. 间隔：运算符两端加空格，可以增加可读性。

2. 缩进 ：四个空格符最优、内部代码块需要缩进、大括号的左边在同一行，闭合的右边要在合适的位置。

3. 注释：

   • 头注释：文件名、编写者、目标、使用方式、所需文件、限制条件、异常处理、历史记录

   • 函数注释：函数的目标、各参数允许的数据类型及含义、返回值应用于何处

   • 修改记录的注释：

     /*add by name for 版本号 at 2022-10-31*/
     

3.变量命名

1. 不要使用相似的变量名
2. 不要以下划线开始命名变量名
3. 不要过度使用下划线
4. 不要滥用大小写区分
5. 不能用相同名称同时命名类和变量

变量的声明和定义请遵循以下规则：

• 局部变量的定义尽量放在代码段的开头
• 尽量为具有特殊意义的变量加上注释
• 请在循环之外定义循环中用到的变量
• 不要将不同类型的变量定义在一行
• 尽可能的在声明局部变量时初始化该变量

注意

1. 变量在调用前应被初始化。
2. 外部输入应进行合法性检查
3. if else if语句，最后应有一个收尾的else，switch语句应有default。
4. 进行比较判断应注意：区分值比较和对象比较，整数类型和字符类型、浮点数不应显示判断相等性和不等行。
5. 函数的调用应使用所有的参数，检查函数的返回值。
6. 应用程序中禁止以Root权限进行各种操作.
7. 数据库访问注意事项。
8. 循环、分支层次不应超过三层。