研究开发部-用户管理组-代码管理试行规范1..doc

路标网 研发部代码管理规范1 介绍(Introduction)本文档基于研究开发部代码管理试行规范，对为什么要有编码规范编码规范对于程序员而言尤为重要，有以下几个原因：- 一个软件的生命周期中，80%的花费在于维护- 几乎没有任何一个软件，在其整个生命周期中，均由最初的开发人员来维护- 编码规范可以改善软件的可读性，可以让程序员尽快而彻底地理解新的代码为了执行规范，每个软件开发人员必须一致遵守编码规范。2 文件组织一个文件由被空行分割而成的段落以及标识每个段落的可选注释共同组成。超过2000 行的程序难以阅读，应该尽量避免。2.1 Java 源文件java源文件遵循以下规则：-开头注释-包和引入语句-类和接口声明开头注释列出版本信息和版权信息。/*copyright*Version information*/包和引入语句Package com.bcc.rnd.user.webImport java.io.*;Import java.util.*;org.apache.shiro.SecurityUtils;import com.bcc.rnd.user.entity.DefaultUser包声明和引入语句之间间隔一空行首先引入java的接口类接着间隔一空行引入第三方接口类最后间隔一空行引入项目中的其他类在引入中，除了引入java基础类可以使用*外，其他的引用必须制定到具体的类名。3 缩进排版使用键盘Tab键作为缩进排版，按一下Tab就是一个缩进单位。3.1 行长度尽量避免一行的长度超过80 个字符，因为很多终端和工具不能很好处理之。注意：用于文档中的例子应该使用更短的行长，长度一般不超过70 个字符。3.2 换行- 在一个逗号后面断开- 在一个操作符前面断开- 新的一行应该与上一行同一级别表达式的开头处对齐4 注释4.1 单行注释/单行注释5 声明5.1 每行声明变量的数量推荐一行一个声明，因为这样以利于写注释。亦即，int level; / indentation levelint size; / size of table要优于，int level, size;5.2 类和接口的声明当编写类和接口是，应该遵守以下格式规则：- 在方法名与其参数列表之前的左括号(间不要有空格- 左大括号位于声明语句同行的末尾- 右大括号另起一行，与相应的声明语句对齐，除非是一个空语句，应紧跟在之后class Sample extends Object int ivar1;int ivar2;Sample(int i, int j) ivar1 = i;ivar2 = j;int emptyMethod() .- 方法与方法之间以空行分隔- Exception的子类名必须以Exception结尾。- 对外提供接口的类需要抛异常。6 异常6.1 异常的捕获和处理Java异常处理涉及到五个关键字，分别是：try、catch、finally、throw、throws异常处理的完整语法是：try/（尝试运行的）程序代码catch(异常类型 异常的变量名)/异常处理代码finally/异常发生，方法返回之前，总是要执行的代码6.2 异常处理的一般原则1、 能处理就早处理，抛出不去还不能处理的就想法消化掉或者转换为RuntimeException处理。2、 对于检查异常，如果不能行之有效的处理，还不如转换为RuntimeException抛出。这样也让上层的代码有选择的余地可处理也可不处理。3、 对于一个应用系统来说，应该有自己的一套异常处理框架，这样当异常发生时，也能得到统一的处理风格，将优雅的异常信息反馈给用户。6.3 异常的转译与异常链尽可能的使用异常转译和异常链，把底层的异常信息传给上层，这样逐层抛出。6.4 一般异常码2000：属性值必填，不能为null、