Java代码样式:类内部的位置

时间:2017-06-21 15:44:47

标签: java coding-style

您可以共享JLS / JEP或其他Oracle / Twitter / Google Java代码样式约定文档,其中声明了类元素的位置。 像:

class Example {
  // public static final variables
  // private static final variables

  // static variables

  // class variables 

  // constructors

  // public methods
  // protected methods

  // inner classes

  // nested classes

  // static methods

  // setter1
  // getter1
  //...
  // setterN
  // getterN

}

1 个答案:

答案 0 :(得分:0)

摘自Google文档: https://google.github.io/styleguide/javaguide.html#s3-source-file-structure

源文件结构

  • 许可或版权信息(如果有)
  • 包声明
  • 导入语句
  • 正好是一个顶级课程
  • 只有一个空行将每个存在的部分分开。

每个顶级类都驻留在自己的源文件中。 您为班级的成员和初始化者选择的顺序可以对学习能力产生很大影响。但是,没有一个正确的方法可以做到这一点;不同的班级可能会以不同的方式订购他们的内容。

重要的是每个类都使用一些逻辑顺序,如果被问到,维护者可以解释它。例如,新方法不仅习惯性地添加到类的末尾,因为这将产生“按时间顺序添加日期”排序,这不是逻辑排序。

当一个类有多个构造函数或多个具有相同名称的方法时,它们按顺序出现,其间没有其他代码(甚至不是私有成员)。

来自Oracle doc:方法应按功能分组,而不是按范围或辅助功能分组。例如,私有类方法可以位于两个公共实例方法之间。目标是使阅读和理解代码更容易。