1、常见问题
2、代码规范示意图
3、高可读性
命名:类、接口、包、变量、方法的命名,严格按照公司的标准进行命名,要具有实际的意义
合理的注释:块注释、行注释、尾注释、方法注释、一些文件的注释、js文件和页面的注释
代码的缩进:空行缩进、if、for、while、switch语句的缩进、try、catch的缩进
4、统一的全局决策
项目开发是一个团队活动,而不是个人的英雄主义。编码规范,要求团队成员遵守统一的全局决策,这样成员之间可以轻松地阅读对方的代码,所有成员正以一种清晰而一致的风格进行编码。而且,开发人员也可以集中精力关注他们真正应该关注的问题——自身代码的业务逻辑,与需求的契合度等局部问题。
5、清晰的逻辑
逻辑混乱导致
- 易读性差
- 维护性差
- 程序执行效率差
如何做到逻辑清晰
- 做好逻辑梳理,可绘制简单流程图辅助开发
- 代码分块,把你的代码按功能或角色分块
- 降低耦合性,一个方法只做一件事
- 可先写注释,后完成代码,写明每一步操作的注释
- 如有必要,可绘制简单时序图辅助开发
6、统一的注释风格
- 统一的类、接口注释,写明其用途,作者等信息
- 方法注释必须写明参数的解释、返回值和方法描述
- 对于修改的代码统一加上修改人,修改时间,修改原因等信息
- 开发过程中有未明确的逻辑需要保留到后期补充完善的,提供TODO语法注释。开发完成时将其去掉
- 针对块注释,行注释,尾注释,可以根据自己需要进行添加,但不宜过多,最好保证平均每十行有一行注释。
(以上信息可由组内或公司统一规定)
7、完善的逻辑判断
对于一个程序员来说,写的代码必须考虑其健壮性。对于写的每一段代码都要仔细推敲,思考全面,才能保证自己的代码健康稳定的运行。
提升程序稳定性的几点建议:
- 方法参数的校验
- 异常信息的处理
- switch必须提供缺省的default语句,注意使用break跳出分支
- 避免死循环
- 合理使用try catch finally语句块,catch语句块不允许为空,finally语句块中不允许使用return
- 文件、流连接要保证及时关闭
8、易维护性
减少重复变量、方法等代码
- 抽象
- 配置
- 模式
- Commons
规范日志的输出
9、高防御性
- 不要仓促的编写代码
- 不相信任何人
- 编码的目标是清晰
- 尽量晚的声明变量
- 小心的进行强制类型装换
- 提供默认的行为
- 魔术数字:非0、1的数字、公共的常量
- 类、方法的修饰符
- Class:Public ? Protected? Private? Default?Final?Abstract?
- Method:Final?Synchronized?
相关推荐
代码规范 代码规范 代码规范 代码规范 代码规范代码规范代码规范
java检查代码规范插件 java检查代码规范插件 java检查代码规范插件 java检查代码规范插件
C#代码规范C#代码规范C#代码规范C#代码规范C#代码规范C#代码规范C#代码规范
阿里巴巴 代码规范
代码规范代码规范代码规范代码规范代码规范代码规范代码规范代码规范代码规范
Java开发代码规范,用于行业内部开发的准则,包括开发标准和开发技巧。
华为代码规范-C C++开发,最新的华为代码规范,适用于C++/C/java,高清带目录
这是借鉴、引用的是京东前端代码规范。
前端代码规范
前端代码规范
java开发代码规范java开发代码规范
代码规范
阿里巴巴Java代码规范
华为公司的代码编写规范,有一定的参考价值
matlab代码规范,并附有详细说明和编程实例
ABAP代码规范二例 内容节选: ******************************** 变量命名规则 Type Name:T_ Internal tables (global): gt_ Internal Tables (Local):it 工作区(structure): wa_ 全局变量: g_ 局部变量: l_ Ranges ...
华为的代码规范,C语言版,适合嵌入式行业的工程师
iOS软件代码规范目录 前 言 4 1. 指导原则 5 2. 布局 5 2.1. 文件布局 6 2.2. 基本格式 8 2.3. 对齐 9 2.4. 空行空格 11 2.5. 断行 13 3. 注释 14 4. 命名规则 17 4.1. 基本规则 17 4.2. 资源命名 19 5. 变量,常量...
ios代码规范整理
JAVA代码规范.docxJAVA代码规范.docxJAVA代码规范.docxJAVA代码规范.docx