java编程代码规范

1.       为方法和类赋予表义性强的名字 <o:p></o:p>

为了使代码更加容易理解，最容易的方法之一是为你的方法赋予表义性强的名字。函数名DoIt、GetIt的可读性很难与CalculateSalesTax、 RetrieveUserID相比。<o:p></o:p>

由缩写方法名组成的代码很难理解和维护，没有理由再这样做了。<o:p></o:p>

给方法正确的命名，可使程序工程的调试和维护工作大大的改观。请认真对待方法命名的工作，不要为了减少键入操作量而降低方法的可理解度。<o:p></o:p>

实际应用举例：<o:p></o:p>

1)    给方法命名时应大小写字母混合使用。如果句子全使用大写字母，那么阅读起来就非常困难，而大小写字母混合使用的句子，阅读起来就很容易。 <o:p></o:p>

2)    定义方法名时不要使用缩写。如果你认为应用程序中的某些工程应使用缩写，那么请将这些情况加上注释，并确保每个人在所有时间内都使用这些缩写。决不要在某些方法中对某些单词进行缩写，而在别的方法中却不使用缩写。 <o:p></o:p>

<o:p> </o:p>

2.       为每个方法赋予单个退出点<o:p></o:p>

<o:p> </o:p>

3.       创建方法时，始终都应显式地定义它的作用域。 <o:p></o:p>

1)    如果你真的想创建一个公用方法，请向代码阅读者说明这一点。<o:p></o:p>

2)    通过为每个方法赋予一个明确定义的作用域，可以减少代码阅读者需要投入的工作量。应确保你为方法赋予最有意义的作用域。如果一个方法只被同一类中的另一个方法调用，那么请将它创建成私有方法。如果该方法是从多个类中的多个方法中调用，请将该说明为公用方法。<o:p></o:p>

<o:p> </o:p>

4.       用参数在方法之间传递数据<o:p></o:p>

应尽量避免使用类变量。一般来说，变量的作用域越小越好。为了减少类变量，方法之一是将数据作为参数在不同方法之间传递，而不是让方法共享类变量。<o:p></o:p>

1)    为每个参数指定数据类型。 <o:p></o:p>

2)    始终要对数进行检验，决不要假设你得数据没有问题。程序员常犯的一个错误是在编写方法时假设数据没有问题。在初始编程阶段，当编写调用方法时，这样的假设并无大碍。这时你完全能够知道什么是参数的许可值，并按要求提供这些值。但如果你不对参数的数据进行检验，那么下列情况就会给你带来很大麻烦：另外某个人创建了一个调用方法，但此人不知道允许的值；你在晚些时候添加了新的调用方法，并错误的传递了坏数据。 <o:p></o:p>

<o:p> </o:p>

3. 命名约定<o:p></o:p>

所有变量的定义应该遵循匈牙利命名法，它使用3字符前缀来表示数据类型，3个字符的前缀必须小写，前缀后面是由表意性强的一个单词或多个单词组成的名字，而且每个单词的首写字母大写，其它字母小写，这样保证了对变量名能够进行正确的断句。<o:p></o:p>

这样，在一个变量名就可以反映出变量类型和变量所存储的值的意义两方面内容，这使得代码语句可读性强、更加容易理解。<o:p></o:p>

<o:p> </o:p>

3.1     包、类及方法命名<o:p></o:p>

<o:p> </o:p>

标示符类型<o:p></o:p>	命名约定<o:p></o:p>	例子<o:p></o:p>
包<o:p></o:p>	l 全部小写。<o:p></o:p> l  标识符用点号分隔开来。为了使包的名字更易读，Sun 公司建议包名中的标识符用点号来分隔。<o:p></o:p> l  Sun 公司的标准 java 分配包用标识符 .java 开头。<o:p></o:p> l 全局包的名字用你的机构的 Internet 保留域名开头 。<o:p></o:p>	局部包：<o:p></o:p> interface.screens<o:p></o:p> 全局包：<o:p></o:p> com.rational.www. interface.screens<o:p></o:p>
类，接口<o:p></o:p>	l 类的名字应该使用名词。<o:p></o:p> l 每个单词第一个字母应该大写。<o:p></o:p> l  避免使用单词的缩写，除非它的缩写已经广为人知，如HTTP。<o:p></o:p>	Class Hello ;<o:p></o:p> Class HelloWorld ;<o:p></o:p> Interface Apple ;<o:p></o:p>
方法<o:p></o:p>	l 第一个单词一般是动词。<o:p></o:p> l  第一个字母是小些，但是中间单词的第一个字母是大写。<o:p></o:p> l 如果方法返回一个成员变量的值，方法名一般为get+成员变量名，如若返回的值是bool变量，一般以is作为前缀。<o:p></o:p> l 如果方法修改一个成员变量的值，方法名一般为：set + 成员变量名。<o:p></o:p>	<o:p> </o:p> getName();<o:p></o:p> setName();<o:p></o:p> isFirst();<o:p></o:p>
变量<o:p></o:p>	l 第一个字母小写，中间单词的第一个字母大写。<o:p></o:p> l 不要用_或&作为第一个字母。<o:p></o:p> l 尽量使用短而且具有意义的单词。<o:p></o:p> l  单字符的变量名一般只用于生命期非常短暂的变量。i,j,k,m,n一般用于integers；c,d,e一般用于characters。<o:p></o:p> l 如果变量是集合，则变量名应用复数。<o:p></o:p> l  命名组件采用匈牙利命名法，所有前缀均应遵循同一个组件名称缩写列表。<o:p></o:p>	String myName;<o:p></o:p> <o:p> </o:p> <o:p> </o:p> <o:p> </o:p> <o:p> </o:p> int[] students;<o:p></o:p>  int i;<o:p></o:p> int n;<o:p></o:p> char c;<o:p></o:p> <o:p> </o:p> btNew;<o:p></o:p> (bt是Button的缩写)<o:p></o:p>
常量<o:p></o:p>	l  所有常量名均全部大写，单词间以‘_’隔开。<o:p></o:p>	int MAX_NUM;<o:p></o:p>

<o:p> </o:p>

3.2     其它<o:p></o:p>

开发人员如果遇到上述表格中未列举的类型，请书面通知相关管理人员，由管理人员集中更新列表内容，不得擅自启用未经确定的新变量前缀。<o:p></o:p>

4. 使用常量<o:p></o:p>

4.1     使用常量<o:p></o:p>

1.       常数很容易在数据输入时出错 <o:p></o:p>

常数存在的主要问题之一是你很容易在键入数字时出错，从而颠倒了数字的位置。例如，当你键入数字10876时，很容易的键入10867或18076。与处理变量和保留字的方法不同，编译器并不在乎颠倒了位置和不正确的数字，有时简单的错误造成的问题不会立即表现出来，而当问题表现出来时，它们会以随机的计算错误的形式出现，这些错误很难准确定位。用常量来取代常数时，编译器将在编译时检查常量的有效性。如果常量不存在，编译器便将这一情况通知你，并拒绝进行编译，这可以消除错误键入的数字带来的问题，只要常量拥有正确的值，使用该常量的所有代码也有使用该正确值。<o:p></o:p>

<o:p> </o:p>

2.       常数很难不断更新<o:p></o:p>

<o:p> </o:p>

3.       常量使代码更容易阅读<o:p></o:p>

使用常量后，得到的一个额外好处是可使创建的代码更容易阅读。常数很不直观。也许你对常数非常了解，但其他人则根本看不明白。通过合理的给常量命名，使用这些常量的代码就变得比较直观了，更容易阅读。<o:p></o:p>

为常量赋予较宽的作用域，这与使用变量时的情况不同。在一个应用程序中你决不应该两次创建相同的常量。如果你发现自己复制了一个常量，请将原始的常量说明转至较宽的作用域，直到该常量可供引用它的所有方法为止。<o:p></o:p>

<o:p> </o:p>

5. 变量<o:p></o:p>

5.1