Java编程规范-.pdf

Java 编程规范（排版，注释，命名，编码等）Java 基础 2009-04-04 10:13 阅读 66 评论 0 字号：大中小这篇文章主要是针对自己平时在写程序是没有注意到得细节而写的，其中大部分是来自华为公司的java 编程规范。一、排版1，分界符“”和“”应各独占一行并位于同一列，同时与引用他们的语句左对齐。在函数的开始、类和接口的定义以及if，for，do，while，switch，case 都应该使用此约定。2，if，for，do，while 语句的执行语句无论多少都要加括号。3，相对独立的程序块之间，变量说明之后必须加空行。4，对齐只使用空格，不使用Tab 键。（这一条主要是为程序在不同的编译器中使用，而不同的编译器对Tab 键的定义有不尽相同）。5，if，for，while，switch 与后面的括号间应加空格，使if 等关键字更加突出。二、注释1，注释和描述内容进行相同的缩排。2，对变量的定义和分支语句必须加注释。3，对 switch 中的 case 语句，如果完成一个case 语句后要进入下一个case 语句，下一个 case 语句前加上明确的注释，这样比较清楚编程人员的意图防止无故遗漏 break 语句。4，边写代码边写注释，修改代码的同时修改注释，保证代码和注释的一致，不再用的注释要删除。5，在程序块结束的右下方加注释标记，以表明程序块的结束。三、命名1，包命名使用小写。2，类名和接口使用类意义完整的英文描述，每个英文单词的首字母大写，其余字母使用小写。3，方法名使用类意义完整的英文描述，第一个单词的字母使用小写，剩余单词的首字母大写其余字母小写。4，方法中，存取属性的方法使用seter 和 getter 方法，动作方法采用动词加动宾结构。格式：get+非布尔属性名（），is+布尔属性名（），set+属性名（），动词（），动词+宾语（）5，属性的命名使用类意义完整的英文描述，第一个单词的字母使用小写，剩余单词的首字母大写其余字母小写，但不允许和方法重名。6，常量使用全大写英文描述，英文单词之间使用下划线分开，并使用final static 修饰。7，属性名可以和方法参数相同，不能和局部变量相同，引用非静态成员变量使用 this 引用，引用静态成员变量使用类名引用。举例：public class Person private String name;private static List properties;public void setName(String name)this.name=name;public static void setProperties(List properties)Person.properties=properties;/end class person建议：1，常用组件类的命名以组件名加上组件类型名结尾。Application 类型-以 App 结尾；MainAppFrame 类型-以 Frame 结尾；TopFramePanel-以 Panel 结尾；CreateCircuitPanelBean类型-以 Bean 结尾；DataAccessBeanEJB类型-以 EJB 结尾；DBProxyEJBApplet类型-以 Applet 结尾。2，函数名超过 15 个字符应该使用行业内通用的方法进相应的缩写。3，准确适用成员函数的存取控制符号。不是必须使用public 的请使用 protected，不是必须使用 protected 的请使用 private。4，具有集合意义的命名，尽量包含其复数的含义。四、编码规范1，明确方法的功能，精确（不是近似）实现方法的设计，遵循功能单一原则。2，明确规定对接口方法参数的合法性检查（默认是方法调用者）。3，明确类的功能，精确实现类的设计，划分类的时候应该尽量把逻辑处理、数据和显示分离实现类功能的单一性。例如：数据类不能包含数据处理的逻辑，通信类不能包含显示处理的逻辑。4，所有的数据类必须重载toString()方法，返回该类的有意义的说明。5，数据库操作，I/O 操作需要使用结束close()的对象必须在 try-catch-finally 的finally 中 close()。6，异常捕获后，如果不对该异常进行处理，应该记录日志e.printStactTrace()。7，自己抛出的异常必须填写详细的描述信息。8，运行期异常使用RuntimeExpception的子类表示，不可在可能抛出异常的方法声明后加 throws 子句。非运行期异常是从Exception 继承而来的，必须在方法声明后加上 throws 子句。9，在程序中是使用异常处理还是错误返回码，由程序结构确定，并且异常和错误码不应该混合使用，推荐使用异常，说明一个系统或者模块应统一规划异常类型和返回码含义，但不能用异常来做一般流程处理的方法，不要过多的使用异常，异常的处理效率比条件分支低且异常的流程难以预测。10，避免使用不易理解的数字，用有意义的标识符代替。11，数组声明使用 int index;这样可读性好。12，调试代码的时候应使用一个包含统一开关的测试类继续拧统一打印，而不是 system.out.pint()。13，用测试开关来切换软件的debug 版本和正式版本，不要存在正式版本个debug 版本的不同文件，减少维护难度。建议1，记录异常不要保存exception.getmessage()，而要记录 exception.toString()。2，一个方法不要抛出太多的异常类型。当然了，在此我并没有列全所有的编码规范，例如注释里面就没有设计问题单注释等，只是针对常见的整理了一下，与钱夹共勉，敲得手痛痛。