java代码编写程序的基本规范

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

1、JAVA代码编写程序的基本规范（一）、Java命名规范1、使用完整描述符来准确地描述　参数或类。例如，使用的名称可以是FirstName、GrandTotal或CorporateCustomer。虽然像x1、y1或fn这样的名称较短容易输入，但是它们并不提供任何信息指出它们所代表的内容。这样对代码的理解、维护和增强会造成一定困难。(变量使用每个中文的头字母，变量第一个字母小写)。2、使用适用于领域内的术语。如果您的用户将他们的客户称为顾客，则对这个类使用术语Customer来代替Client。许多开发人员曾经犯了这样一个错误：当业界

2、或领域中已存在更贴切的术语时，他们还冥思苦想，准备为一些概念创建通用术语。3、巧妙节俭地使用缩写。这表示您应该维护一份标准短格式（缩写）的列表，应该明智地选择它们，并在使用时保持一贯性。例如，如果要使用字arithmetic的短格式，选择ar、ari或art中的一个，记录下所选的缩写（到底是哪个并不重要），并只使用这一个。（陈涛负责）4、使用大小写混合增强名称的可读性。通常应该使用小写字母，但是将类名和接口名称的第一个字母写成大写，将所有非起始单词的第一个字母也写成大写。5、将标准首字母缩写词的第一个字母大写。名称会经常包含标准缩写

3、，如SQL表示“StandardQueryLanguage”。诸如表示属性的sqlDatabase或表示类的sQLDatabase等名称比sQLDatabase和SQLDatabase更便于阅读。6、避免长型名称（最大15个字符比较合适）。虽然类名AllImplementedIterfacesAndSubclass可能是个比较好的类名（当然，在此示例中有些夸张），但是这个名称显然太长，应该把它重命名为较短的名称才好。7、避免名称过于相似或仅在大小写方面有区别。不应该同时使用变量名myObject和myObjects，也不应该同时使用

4、myOraDatabase和anORADatabase。8、方法的命名方法名应该是动词，大小写可混用，但首字母应小写。在每个方法名内，大写字母将词分隔并限制使用下划线。参数的名字必须和变量的命名规范一致，问题参数名是否采用以下划线开始作为统一标识，如setCounter(int_size)，以标识成员变量size和传入参数_size区别。使用有意义的参数命名，如果可能的话，使用和要赋值的字段一样的名字：setCounter(intsize){this.size=size;}9、数组的命名数组应该总是用下面的方式来命名：byte[]b

5、uffer;而不是：bytebuffer[]。10、Package的命名Package的名字应该都是由一个小写单词组成，例如：net.ebseries.modules。11、Class的命名Class的名字必须由大写字母开头而其他字母都小写的单词组成，例如：DataFile或InfoParser。12、Class变量的命名变量的名字可大小写混用，但首字符应小写。词由大写字母分隔，限制用下划线，限制使用美元符号（$），因为这个字符对内部类有特殊的含义。如：inputFileSize。类中的属性不能定义为public变量直接存取，而是定

6、义成protect变量来防止继承类使用他们并编写get/set方法。13、Class属性(成员变量)使用Class属性(成员变量)使用一定要加前缀this或super标识对应的成员变量，以增加程序的可读性。14、StaticFinal变量的命名StaticFinal变量的名字应该都大写，并且指出完整含义，例如：finalMAXUPLOADFILESIZE=1024。（二）、代码格式1、文档化必须用javadoc来为类生成文档。不仅因为它是标准，这也是被各种java编译器都认可的方法。2、缩进缩进应该是每行4个空格.不要在源文件中保存

7、Tab字符.在使用不同的源代码管理工具时Tab字符将因为用户设置的不同而扩展为不同的宽度。3、大括号{}{}中的语句应该单独作为一行.例如,下面的第1行是错误的,第2行是正确的:if(i>0){i++};//错误,{和}在同一行if(i>0){i++};//正确,{单独作为一行4、括号()左括号和后一个字符之间不应该出现空格,同样,右括号和前一个字符之间也不应该出现空格.下面的例子说明括号和空格的错误及正确使用:CallProc(AParameter);//错误CallProc(AParameter);//正确不要在语句中使用无意义

8、的括号.括号只应该为达到某种目的而出现在源代码中。下面的例子说明错误和正确的用法:if((I)=42){//错误-括号毫无意义if(I==42)or(J==42)then//正确-的确需要括号5、注释//注释一行　　/*......*