Java代码风格：内部职位

Question

您可以共享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 

} 

Answer 1

从谷歌文档的摘录：https://google.github.io/styleguide/javaguide.html#s3-source-file-structure

源文件结构

• 许可证或版权信息，如果存在的话
• 包语句
• import语句
• 正好有一个顶级类
• 确切地说，一个空行分隔出现的每个部分。

每个顶级类都驻留在它自己的源文件中。 您为班级的成员和初始化者选择的顺序可能会对可学习性产生很大影响。但是，如何做到这一点，没有单一的正确配方。不同的课程可能以不同的方式排列其内容。

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

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

从Oracle文档：方法应按功能而不是范围或可访问性进行分组。例如，私有类方法可以位于两个公共实例方法之间。目标是让阅读和理解代码更容易。