编码规范v1.pptVIP

? 2015 冠辰世纪信息技术有限责任公司 ? 2015 冠辰世纪信息技术有限责任公司 ? 2015 冠辰世纪信息技术有限责任公司 绝密（仅限珞璜园区与冠辰世纪） ? 2015 冠辰世纪信息技术有限责任公司 绝密（仅限珞璜园区与冠辰世纪） ? 2015 冠辰世纪信息技术有限责任公司 绝密（仅限珞璜园区与冠辰世纪） ? 2015 冠辰世纪信息技术有限责任公司 绝密（仅限珞璜园区与冠辰世纪） ? 2015 冠辰世纪信息技术有限责任公司 绝密（仅限珞璜园区与冠辰世纪） ? 2015 冠辰世纪信息技术有限责任公司 绝密（仅限珞璜园区与冠辰世纪） ? 2015 冠辰世纪信息技术有限责任公司 绝密（仅限珞璜园区与冠辰世纪） ? 2015 冠辰世纪信息技术有限责任公司 绝密（仅限珞璜园区与冠辰世纪） ? 2015 冠辰世纪信息技术有限责任公司 绝密（仅限珞璜园区与冠辰世纪） ? 2015 冠辰世纪信息技术有限责任公司 绝密（仅限珞璜园区与冠辰世纪） ? 2015 冠辰世纪信息技术有限责任公司 绝密（仅限珞璜园区与冠辰世纪） 代码规范v1 2015年11月 编码规范指南 排版规范 程序块采用缩进，缩进空位为4个； 分解符如“{”和“}”独占一行，并且位于同列； 较长的语句、表达式、参数要书写多行； 一行只写一条语句； if,for,do,while,case,switch,default 独占一行，且语句块都要加“{ }”,无论语句多少 相对独立的业务语句块之间，变量说明后加空行 对齐只用空格不用TAB，避免不同编辑器对TAB处理不同 对二个以上的关键字、变量、常量进行对等操作时，变量前后必须留空格，如果if( a == b) 类属性和方法不用交叉放置，不同存取范围的属性或方法也不远交叉放置 编码规范指南 注释规范 有代码的地方就有注释，杜绝没有任何注释的代码，推荐注释量在20%以上； 包的注释：在包的当前路径放入一名为package.html的HTML文件，方面JavaDoc收集。注释内容简述本包的作用、内容、产品模块、版本、版权等，如： 文件注释：文件开始，package 关键字前面，记载版权说明、描述信息、生成日期、修改历史；如： 编码规范指南 4、类和接口的注释：在package之后，class或interface之前，描述当前类或接口的功能，作者，生成日期，修改日志，版本号等，如： 5、类属性、方法注释：在类或方法的前面，类属性记载属性的功能用处，用/* 开头描述注释，放置JavaDoc收集；类方法注释需要记载方法的功能简述、详细、输入参数、输出值、抛出的异常、作者等，如： 编码规范指南 6、类方法内部注释： 注释应放置被注释语句的正上方或右侧； 注释必须与被注释的语句同缩进； 注释与上面的代码只有用一个空行隔开； 属于同一业务逻辑块的代码，须显示注释用途； 对于变量定义和分支语句（if, switch, case）必须注释； 写代码的同时写注释，修改代码的同时，也修改注释； 注释块内部请不要加缩进； 注释内容内部需要着重提示的，请包括标签bxxxx/b 对于业务逻辑比较多的方法，建议显示注释步骤1、2,、3、4… 注释含义明确，不要写无意义的注释和难以理解的词汇，如； 编码规范指南 命名规范 上面说道了注释规范，注释的目的在于帮助编码人员更好的理解代码、维护代码。当然有些地方，如果命名非常规范，是可以不用注释的，下面就说说又哪些命名规范； 包的命名：常用命名方式：com.公司名.产品线名.项目名.模块名，所有名称全部小写，如下图： 2、类名和接口名的命名：尽量使用完整的英文描述，首字母大写，每个英文单词的首字母大写，其余字母小写。抽象类请以Abstract开头，接口的实现类请以Impl接口，工具类请以Util或Utils结尾，如下列命名方式： StaffService、DefaultStaffService、AbstractEntity、StringUtils； 3、方法命名；尽量使用完整的英文描述，首字母小写，每个英文单词的首字母大写，其余字母小写，属性存取尽量使用setX、getX，返回布尔类型值的方法尽量使用isX，如下列命名方式： queryStaffById、isCodeExists()、getValue 4、属性命名；尽量使用完整的英文描述，首字母小写，每个英文单词的首字母大写，其余字母小写，属性名和方法名不要重复； 5、常量命名；使用全部大写的英文描述，每个单词之间用下划线分隔，变量之前近可能使用final修饰，注意：枚举也是一种常量； 6、模块内部的组件，尽量以组件名开头，如：StaffDAO、StaffService； 7