阅读编码规范心得.doc

关于Java编码规范的心得 Java命名 1、类名首字母应该大写，属性、方法、对象变量以及所有标识符的首字母小写，所有单词都应该靠在一起，中间不留空格货其他连接字符，除首单词的首字幕小写剩余单词首字母都大写。 举例： 类名： StudentAction 构造方法名： addStudent 2、Java包名全部都用小写字母。 在代码中包行要写在代码的首行及import行之前。 举例：package action Import java.util.*; 3、借口：采用完整的英文描述符说明借口的封装，所有单词的第一个字母大写。 4、类中常用方法命名： 1类的获取方法（一般具有返回值）一般用要获取的字段名，前面加上get, 举例：getNoteID() 2类的布尔型的方法一般在方法名中前缀用is 举例：isString() 3类的设置方法（一般返回类型为void）一搬用要设置的字段名，前面加上set前缀 举例：setNoteID() 4类的一般方法一般采用完整的英文描述说明成员方法功能，首字母小写 举例:addStudent() 5构造方法应该用递增的方式写，参数多的写在后面 举例：public addStudent(String id) Public showStudent(String id,String name) 6如果在类中写入了一个main()方法，那么应把它写在类中代码最下面。 5、静态常量字段（static final）一般全部采用大写字幕，单词之间用下划线分开 举例：static final String MAX_NUMBER; Java注释 类的整体注释：遵循JavaDoc的规范，每个源文件的开头著名这个类的作用，作简要说明，并写上源代码作者，编写日期，如果修改的别人编写的源文件，要在修改信息上注明修改人和修改日期。 举例： /** * @ (#)StudentAction.java * @ 描述：该类响应页面传来的对Student表的操作 * @ 作者：吕俊杰 2011年5月30日 * @ 版本：v1.1 */ 2、类中方法的注释：遵循JavaDoc的规范，每个方法的前部用块注释的方法描述此方法的作用，以及传入，传出的参数类型和作用，以及需要捕获的错误 举例： /** *@ addStudent() *@ 描述：该方法执行添加一名学生的记录 *@ 参数： 传入参数Student类型的student *@ 返回类型：返回类型布尔型 *@ 出错信息描述：数据库操作异常 */ 3、行注释：使用//的注释方式来注释需要说明的内容，并且把注释的内容放在需要注释代码前一行或同一行。 4、块注释：使用/** 和*/ 的方法来注释需要说明的内容，注释内容放在需要注释代码块前面。 三、Javabean开发规范 1、数据库连接规范 开发过程中数据库连接通过调用一个写好的数据库连接类jdbc来实现如：StudentJdbc.Java 数据库的连接放在数据库的构造方法中建立 在每个方法中如果对数据库操作结束，必须调用jdbc类中的close（）方法释放数据库连接对象，关闭数据库连接。 代码书写规范 每一行代码不要过长，保持每一行代码在页面宽度的80%到90%即可，较长的代码采用分行显示，第二行在第一行的基础上缩进两个空格。 Javabean中各个方法之间保持两行的间隔。 大括号｛｝的使用规定：在使用时，如果不是在一行代码中应保持左右括号保持上下对齐，大括号里的首行代码必须在下一行，缩进两个空格。 定义变量时，如果同一个类型的变量数量小于3个则一起定义，如果大于三个就分开定义。 例外控制规范 在编写javabean时，例外的通知一般有两种方式： 一种是在方法中捕获，主要使用于对具体类型例外，并且在那里发生异常不清楚的情况下用 另一种是通过使用try{} catch(Exception e){}的方法来捕获。使用于清楚的了解例外发生情况。 Java中编码其他的约定 jsp文件命名采用完整的英文描述说明jsp所完成的功能。 举例：addStudent.jsp Servler类命名一般应用于所服务的对象加Service后缀来命名。 举例：StudentService.java 尽量少使用synchronized关键字。 尽量使用借口而不是使用一个具体的类。 这些就是我在看了Java编码规范的心得，写出了我们平时写代码时不太注意或者不清楚的一些规范内容，根据正确的规范