JAVA开发规范.doc

JAVA类编写规范基本命名规范:类、接口命名命名规范:以大写字母开头,如果有多个单词,每个单词头字母大写例如:StudentInfo接口命名命名规范:以大写字母"I"开头,如果有多个单词,每个单词头字母大写例如:IStudentInfo接口实现类命名:命名规范:将实现的接口名称的首字母"I"去掉,以"Impl作为结尾",如果有多个单词,每个单词头字母大写。例如:StudentInfoImpl类的命名 类的名字必须由大写字母开头而单词中的其他字母均为小写;如果类名称由多个单词组成,则每个单词的首字母均应为大写例如TestPage;如果类名称中包含单词缩写,则这个所写词的每个字母均应大写,如:XMLExample,还有一点命名技巧就是由于类是设计用来代表对象的,所以在命名类时应尽量选择名词。 例如:Circle 变量命名:命名规范:变量名首字母必须小写,如果该变量名有多个单词组成,后面的单词首字母大写,单词与单词之间不要使用"_"做连接,变量名访问控制必须为私有,可以对其增加setter与getter方法。例如:privateintstudentAge;publicintgetStudentAge(){returnstudentAge;}publicvoidsetStudentAge(intstudentAge){=studentAge;}常量命名:命名规范:所有字母大写,如果有多个单词组成,单词与单词之间以”_“隔开。而且该变量必须是公共、静态、final类型例如:publicstaticfinalStringUSER_NAME=”userName“;方法命名命名规范:首字母必须小写,如果该变量名有多个单词组成,后面的单词首字母大写,单词与单词之间不要使用"_"做连接。单词不要使用名词。例如:publicintcheckLogin(Stringname,Stringpwd){}注释规范:注释规范是整个开发规范中最为重要的组成部分,必须严格执行。类的注释:作用:注释整个类,简单概述该类作用。书写规范:类的注释必须写在该类的声明语法之前。在注释中要描述该类的基本作用,作者,日期,版本,公司名称,版权声明。格式:变量、常量注释:作用:简单描述该变量的意义。书写规范:变量注释必须写在变量定义之前,简单描述其代表的意义。格式:例如://年龄publicintage;方法注释:作用:对该方法功能简单描述,其参数、返回值意义的注解。书写规范:方法注释必须写在方法定义之前。该注释包括:方法其功能的简单描述,方法的参数、返回值类型、返回值意义简单的描述。格式:例如:publicbooleaneditAdminPassword(intadminId,StringoldPassword,Stringpassword)throwsUserException,ServiceException;包的命名 Java包的名字都是由小写单词组成。但是由于Java面向对象编程的特性,每一名Java程序员都可以编写属于自己的Java包,为了保障每个Java包命名的唯一性,在最新的Java编程规范中,要求程序员在自己定义的包的名称之前加上唯一的前缀。由于互联网上的域名称是不会重复的,所以程序员一般采用自己在互联网上的域名称作为自己程序包的唯一前缀。 .front