怎样写规范的代码.pptx

© ZTEsec Corporation. All rights reserved
怎样写规范的代码
Coding Specification
综合业务产品线/秦亮
2013年12月05日
培训提纲
代码规定化的意义
编码规范指南
怎样写规范的代码
代码检查工具介绍及使用
代码规范化的意义
作为一个编码人员,你一定维护过别人的代码,你曾经骂过“这真实一坨坨”,还是对其赞叹尤佳呢,我当然希望比人不要骂我的好。事实证明代码总会被很多人去维护;
一个软件的生命周期中,80%的花费在于维护,规范的代码可以减少编码人员的理解时间,降低维护代价,易于进行二次开发;
几乎没有任何一个软件,在其整个生命同期中,均由最初的开发人员来维护,所以作为最初的你最好留下好的口碑;
编码规范可以改善软件的可读性,可以让程序员尽快而彻底地理解新代码;
如果你将源码作为产品发布,需要按照规范,确认它是否被很好的打包并且清晰无误;
本文的目的不在于用条条框框来约束编码人员,而在于用建议性的规范帮助编码人员写出易理解、易维护、易扩展的优秀代码。
编码规范指南
排版规范
程序块采用缩进,缩进空位为4个;
分解符如“{”和“}”独占一行,并且位于同列;
较长的语句、表达式、参数要书写多行;
一行只写一条语句;
if,for,do,while,case,switch,default 独占一行,且语句块都要加“{ }”,无论语句多少
相对独立的业务语句块之间,变量说明后加空行
对齐只用空格不用TAB,避免不同编辑器对TAB处理不同
对二个以上的关键字、变量、常量进行对等操作时,变量前后必须留空格,如果if( a == b)
类属性和方法不用交叉放置,不同存取范围的属性或方法也不远交叉放置
编码规范指南
注释规范
有代码的地方就有注释,杜绝没有任何注释的代码,推荐注释量在20%以上;
包的注释:,方面JavaDoc收集。注释内容简述本包的作用、内容、产品模块、版本、版权等,如:
文件注释:文件开始,package 关键字前面,记载版权说明、描述信息、生成日期、修改历史;如:
编码规范指南
命名规范
上面说道了注释规范,注释的目的在于帮助编码人员更好的理解代码、维护代码。当然有些地方,如果命名非常规范,是可以不用注释的,下面就说说又哪些命名规范;
包的命名:.,所有名称全部小写,如下图:
编码规范的范畴
2、类名和接口名的命名:尽量使用完整的英文描述,首字母大写,每个英文单词的首字母大写,其余字母小写。抽象类请以Abstract开头,接口的实现类请以Impl接口,工具类请以Util或Utils结尾,如下列命名方式:
StaffService、DefaultStaffService、AbstractEntity、StringUtils;
3、方法命名;尽量使用完整的英文描述,首字母小写,每个英文单词的首字母大写,其余字母小写,属性存取尽量使用setX、getX,返回布尔类型值的方法尽量使用isX,如下列命名方式:
queryStaffById、isCodeExists()、getValue
4、属性命名;尽量使用完整的英文描述,首字母小写,每个英文单词的首字母大写,其余字母小写,属性名和方法名不要重复;
5、常量命名;使用全部大写的英文描述,每个单词之间用下划线分隔,变量之前近可能使用final修饰,注意:枚举也是一种常量;
6、模块内部的组件,尽量以组件名开头,如:StaffDAO、StaffService;
7、组件命名,尽量以组件类型结果,如:Service;
8、准确控制类成员方法的修饰符,如果仅限于类内部使用用private修饰,可供子类或本包内部使用用protected修饰,对所有公开,则用public;
9、属性和方法的命名不易过长,一般不超过15个字母;