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文檔：方法應按功能而不是範圍或可訪問性進行分組。例如，私有類方法可以位於兩個公共實例方法之間。目標是讓閱讀和理解代碼更容易。