[置顶] 代码规范

版权声明：本文为博主原创文章，未经博主允许不得转载。 https://blog.csdn.net/lanjian056/article/details/52711320

1、常见问题

2、代码规范示意图

3、高可读性

命名：类、接口、包、变量、方法的命名，严格按照公司的标准进行命名，要具有实际的意义

合理的注释：块注释、行注释、尾注释、方法注释、一些文件的注释、js文件和页面的注释

代码的缩进：空行缩进、if、for、while、switch语句的缩进、try、catch的缩进

4、统一的全局决策

项目开发是一个团队活动，而不是个人的英雄主义。编码规范，要求团队成员遵守统一的全局决策，这样成员之间可以轻松地阅读对方的代码，所有成员正以一种清晰而一致的风格进行编码。而且，开发人员也可以集中精力关注他们真正应该关注的问题——自身代码的业务逻辑，与需求的契合度等局部问题。

5、清晰的逻辑

逻辑混乱导致

• 易读性差
• 维护性差
• 程序执行效率差

如何做到逻辑清晰

• 做好逻辑梳理，可绘制简单流程图辅助开发
• 代码分块，把你的代码按功能或角色分块
• 降低耦合性，一个方法只做一件事
• 可先写注释，后完成代码，写明每一步操作的注释
• 如有必要，可绘制简单时序图辅助开发

6、统一的注释风格

1. 统一的类、接口注释，写明其用途，作者等信息
2. 方法注释必须写明参数的解释、返回值和方法描述
3. 对于修改的代码统一加上修改人，修改时间，修改原因等信息
4. 开发过程中有未明确的逻辑需要保留到后期补充完善的，提供TODO语法注释。开发完成时将其去掉
5. 针对块注释，行注释，尾注释，可以根据自己需要进行添加，但不宜过多，最好保证平均每十行有一行注释。

（以上信息可由组内或公司统一规定）

7、完善的逻辑判断

对于一个程序员来说，写的代码必须考虑其健壮性。对于写的每一段代码都要仔细推敲，思考全面，才能保证自己的代码健康稳定的运行。

提升程序稳定性的几点建议：

1. 方法参数的校验
2. 异常信息的处理
3. switch必须提供缺省的default语句，注意使用break跳出分支
4. 避免死循环
5. 合理使用try catch finally语句块，catch语句块不允许为空，finally语句块中不允许使用return
6. 文件、流连接要保证及时关闭 

8、易维护性

减少重复变量、方法等代码

•  抽象
•  配置
•  模式
•  Commons

规范日志的输出

9、高防御性

1. 不要仓促的编写代码
2. 不相信任何人
3. 编码的目标是清晰
4. 尽量晚的声明变量
5. 小心的进行强制类型装换
6. 提供默认的行为
7. 魔术数字：非0、1的数字、公共的常量
8. 类、方法的修饰符

• Class：Public ? Protected? Private? Default?Final?Abstract?
• Method：Final?Synchronized?

• 
• 大小: 83.2 KB

• 
• 大小: 52.8 KB

• 
• 大小: 11.1 KB

• 查看图片附件