3.3 编程风格指南

到目前为止,Oracle没有提供与时俱进的官方Java语言编程风格指南,这方面的最新指南是Sun 公司于1999年发布的,本书编写期间还保留在Java网站上。下面是其中一些在当前依然适用的要点。

  • 建议每个项目文件都以相同的注释打头,并在其中至少包含类名和版权信息。
  • 公有类或公有接口必须放在文件的开头。如果文件还包含和具有其他访问限定符的其他类或接口,应将其放在公有类或公有接口后面。
  • 按如下顺序定义类或接口。

    (1) 类或接口的Javadoc注释(这个主题将在下一章讨论)。

    (2) 关键字classinterface(包括访问限定符和其他限定符)。在接口名或类名后面,表示类代码块起始位置的{字符应与接口名或类名位于同一行,但表示类代码块结束位置的}字符独占一行。

    (3) 包含文档中没有的实现信息的文档。

    (4) 按如下顺序排列的静态变量:

      • 公有的静态变量;

      • 受保护的静态变量;

      • 包私有(没有访问限定符)的静态变量;

      • 私有的静态变量。

    (5) 实例变量(排列顺序与静态变量相同)。

    (6) 构造函数。

    (7) 方法(按功能而不是访问限定符分组)。

  • 不要在同一行声明多个变量,而让每个变量声明都独占一行。
  • 尽可能在声明变量的同时初始化它。
  • 变量声明应放在用{ }括起的代码块的开头,而不要在代码块中间声明变量。