java编码规范.doc

《java编码规范.doc》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、开发过程中，建立JAVA开发规范，统一JAVA代码的编码风格，可以增加清晰性和可阅读性，便于走查和维护！一工程编码建议工程名表意明确工程项目编码格式使用UTF-8文件的编码类型统一为UTF-8二开发编码规范2.1排版规范要求2.1.1缩进风格规则：代码采用缩进风格，tab用4个空格替代。代码中避免使用tab。说明：用不同的编辑器阅读程序时，因TAB键所设置的空格数目不同而造成程序布局不整齐。在eclipse和myeclipse中可以设置tab转换为空格。配置方法如下：（1）点击window->prefe

2、rences->General->Editors->TextEditors，设置如下界面中红色标记内容。2.1.2分界符2.2.2.1大括号｛｝规则1：大括号与if,else,for,do,while语句一起使用，即使只有一条语句(或是空)，也应该把大括号写上。示例：规则2：左大括号前不换行，左大括号后换行，右大括号前换行如果右大括号是一个语句、函数体或类的终止，则右大括号后换行;否则不换行。例如，如果右大括号后面是else，catch或逗号，则不换行。示例：一个空的块状结构里什么也不包含，大括号可以简

3、洁地写成{}，不需要换行，如构造函数等2.2.2.2空格规则1：除方法的声明和调用外，小括号前一定要有一个空格。规则2：分隔任何保留字与紧随其后的左括号(如if,forcatch等。规则3：分隔任何保留字与其前面的右大括号}如else,catch。规则4：在任何左大括号前{要有空格规则5：在任何二元或三元运算符的两侧。这也适用于以下“类运算符”符号：类型界限中的&()。规则6：在,:;及右括号)后要有一个空格规则7：声明变量时，在类型和变量之间要有一个空格，如int n

4、umber。规则8：单目操作符前后不加空格如："!"、"~"、“++"、"--"、"&"（地址运算符）等前后不需要加空格。规则9："."前后不加空格。2.1.3代码行字数限制规则：每行代码的字符数应该不超过125个字符。说明：较长的语句、表达式或参数（>125字符）要分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读。MyEclipse设置方法：window->preferences->java->codestyle->format

5、ter->edit->linewrapping->maximumlinewidth new一个新的CodeStyle模板，并将该项设为1252.1.4代码行语句限制规则1：每行代码不能出现多个语句，每行只能有一个语句。规则2：每行不能声明多个变量，一行只能声明一个变量，且声明变量时应该有初始化值。2.1.5定义排序规则：类属性和类方法不要交叉放置，不同存取范围的属性或者方法也尽量不要交叉放置格式：2.2命名规范要求2.2.1包名规范包名采用域后缀倒置加上自定义的包名，包名采用小写字母。在部门内部应该规划

6、好包名的范围，防止产生冲突。部门内部产品使用部门的名称加上项目名称。产品线的产品使用产品的名称加上模块的名称。格式：com.demo.b2b.模块名称com.demo.bookStore.项目名称2.2.2类名规范规则1:类名和接口名，是个名词，使用类意义完整的英文描述，每个英文单词的首字母使用大写、其余字母使用小写的大小写混合法，俗称：驼峰命名法。如：OrderInformation,CustomerList,LogManager,PropertiesManager规则2：定义接口，名称前面要加I，接

7、口的实现，后面要加Impl，如:IUserService：表示接口IUserServiceImpl：表示接口的实现2.2.3方法名规范规则1：方法名是一个动名词，使用类意义完整的英文描述：第一个单词的字母使用小写、剩余单词首字母大写其余字母小写的大小写混合法。规则2：方法中，存取属性的方法采用setter和getter方法，动作方法采用动词和动宾结构。规则3：返回类型为boolean的方法，必须以is开头。格式：get+非布尔属性名()is+布尔属性名()set+属性名()动词()动词+宾语()示例：2

8、.2.4属性名规范规则1：属性名使用意义完整的英文描述：第一个单词的字母使用小写、剩余单词首字母大写，其余字母小写。规则2：属性名不能与方法名相同。规则3：类型为boolean的属性名称前必须以is开头。规则4：变量名不应以下划线或美元符号开头。规则5：含有集合意义的属性命名，尽量包含其复数的意义。示例：2.2.5常量名规范规则：常量名使用全大写的英文描述，英文单词之间用下划线分隔开，并且使用staticfinal修饰。示例：建议：对于Lo