java代码编程规范

类的成员变量定义

大部分类的成员变量应该定义为protected来防止继承类使用他们。

数组标识

要用\"int[]packets\"，而不是\"intpackets[]\"，后一种永远也不要用。

成员变量与函数内局部变量用this

publicvoidsetPackets(int[]packets){this.packets=packets;}//一般函数

CounterSet(intsize){this.size=size;}//构造函数

可读性

避免使用不易理解的数字，用有意义的标识来替代。不要使用难懂的技巧性很高的语句。

源程序中关系较为紧密的代码应尽可能相邻。

可移植性

BorlandJbulider不喜欢synchronized这个关键字，如果你的断点设在这些关键字的作用域内的话，调试的时候你会发现的断点会到处乱跳，让你不知所措。除非必须，尽量不要使用。

换行

如果要换行的话，尽量用println来代替在字符串中使用\"\\n\"。

你不要这样:System.out.print(\"Hello,world!\\n\");

要这样：System.out.println(\"Hello,world!\");

或者构造一个带换行符的字符串，至少要象这样：

Stringnewline=System.getProperty(\"line.separator\");

System.out.print(\"Helloworld\"+newline);

PrintStream

PrintStream已经被不赞成（deprecated）使用，用PrintWrite来代替她。

排版规范

关键词和操作符之间加适当的空格。

相对独立的程序块与块之间加空行。

较长的语句、表达式等要分成多行书写。

划分出的新行要进行适应的缩进，使排版整齐，语句可读。

长表达式要在低优先级操作符处划分新行，操作符放在新行之首。

循环、判断等语句中若有较长的表达式或语句，则要进行适应的划分。

若函数或过程中的参数较长，则要进行适当的划分。

不允许把多个短语句写在一行中，即一行只写一条语句。

函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格。

编写程序块时‘{’和‘}’应各独占一行并且位于同一列，同时与引用它们的语句左对齐。在函数体的开始、类的定义、结构的定义、枚举的定义以及if、for、do、while、switch、case语句中的程序都要采用如上的缩进方式。

性能

在写代码的时候，从头至尾都应该考虑性能问题。这不是说时间都应该浪费在优化代码上，而是我们时刻应该提醒自己要注意代码的效率。比如：如果没有时间来实现一个高效的算法，那么我们应该在文档中记录下来，以便在以后有空的时候再来实现她。

不是所有的人都同意在写代码的时候应该优化性能这个观点的，他们认为性能优化的问题应该在项目的后期再去考虑，也就是在程序的轮廓已经实现了以后。

不要在循环中构造和释放对象

使用StringBuffer对象

在处理String的时候要尽量使用StringBuffer类，StringBuffer类是构成String类的基础。String类将StringBuffer类封装了起来，（以花费更多时间为代价）为开发人员提供了一个安全的接口。当我们在构造字符串的时候，我们应该用StringBuffer来实现大部分的工作，当工作完成后将StringBuffer对象再转换为需要的String对象。比如：如果有一个字符串必须不断地在其后添加许多字符来完成构造，那么我们应该使用StringBuffer对象和她的append()方法。如果我们用String对象代替StringBuffer对象的话，会花费许多不必要的创建和释放对象的CPU时间。

避免太多或不必要的使用synchronized关键字

，应该在必要的时候再使用她，这是个避免死锁的好方法。

代码测试、维护

1.单元测试要求至少达到语句覆盖。

2.单元测试开始要跟踪每一条语句，并观察数据流及变量的变化。

3.清理、整理或优化后的代码要经过审查及测试。

4.代码版本升级要经过严格测试。

类名/接口名（*.java）：
首字符大写，后面的小写；后续单词的第一个字符大写。如MyClass。
并且注意可读性，不要用拼音。尽量是名词。

变量名/对象名：
首字符小写，后面的小写；后续单词的第一个字符大写（与类名的不同就是首字符的大小写而已）。如userName。一般也为名词（它是对象的属性）

方法名：
（与变量名相同）但是取名时一般为动词，是对象有行为/动作。如getUserName()

空行与空格的使用：
方法之间用空行隔开
方法内，两段功能不同的代码也用空行隔开。最好是能加上注释

拿本网站的用户（就是你我他啦）来说，我们可以写出一个用户的类（只是模拟而已，且没有写全），如下：
public class User{

      private int uID ;   //用户ID
      private String uName;   //用户名
      private int essentialCount ;  // 精华贴数量
      private int point;   // 积分
      private int topicCount; //发帖子数量
      private int replyCount; //回贴子数量
      private int experienceCount; //经验值
      private Date createDate;  //注册日期
      private String status; //用户状态

      public void setUID(int uID){
            this.uID = uID;
      }

      public int getUID(){
            return this.uID;
      }

      //此方法只是想说明在方法中如何使用空行(不管此方法放在这里是否合适乎)，至于如何计算积分的，俺也不清楚，呵呵
      public void setPoint(){
            //计算发贴子积分
            .......

            //计算回贴积分
            ......
  
            //计算精华贴积分
            ......


            //计算总积分：前三者之和
            ......


      }

}

[ 本帖最后由 moonalan 于 2006-11-26 23:09 编辑 ]