是否有一個「行規」的Java

我要整理我的Java是一種編碼規範文件一點點，想知道是否有這樣做的標準方式。例如：是否有一個「行規」的Java

public class Example 
{ 
    private int exampleInt; 
    private String exampleString; 

    /*------------------------------------------------------------*/ 
    /* I N N E R C L A S S E S         */ 
    /*------------------------------------------------------------*/ 
    private someInnerClass 
    { 
      someInnerClass() 
      { 
      } 
    } 
    /*------------------------------------------------------------*/ 

    /** 
    * This method returns the example int. 
    */ 
    public int getExampleInt() { 
      return exampleInt; 
    } 
}

我不叫什麼，我有一種評論休息 /的一部分-------------------- ---------------------------------------------/ Is there這種事情的任何約定？或者這是我不應該做的事情，因爲大多數IDE將在某種大綱視圖中向您顯示所有內容？

來源

2009-07-24 uriDium

...也許getExampleInt應該有int作爲返回類型？ :-) – raoulsson 2009-07-24 08:52:37

重構和源代碼清理可能會導致您的源文件被重新組織，包括註釋。

我建議你不這樣做，因爲這樣的評論可能最終某處完全無關。

你可能想嘗試，而不是另一件事是用你的IDE重新格式化您的來源。 Eclipse允許每次保存文件時都這樣做。這將使您的所有代碼具有一致的外觀，以便於閱讀。

來源

2009-07-24 08:51:48

該代碼解釋了它自己。沒有必要把這些難看的長註釋行。如果你真的要，然後讓他們短，像這樣：

// ------------- 
// Inner Classes 
// -------------

這是不太凌亂。當我遇到這些明顯的評論時，我通常會在那裏刪除它們。

來源

2009-07-24 08:50:49 raoulsson

我的想法確切！ – willcodejavaforfood 2009-07-24 08:56:29

你應該看看註釋約定Javadoc工具，Netbeans和其他IDE的是用來把它們當成你的代碼是如何工作的主要描述，它應該概括它沒有問題

How to Write Doc Comments for the Javadoc tool

來源

2009-07-24 08:51:07 fixmycode

這裏的一些思考：如果有人在你的團隊並不想跟着您的評論打破慣例，什麼是從把他們的方法，無論他們想阻止他們？如果他們錯誤地使用某種方法，你會如何發現它？評論中斷不會強制遵守規定，所以你不能相信它們。因此，如果您最終將使用IDE的好功能來查找方法，那麼爲什麼不從一開始就這樣做呢？

總之，是的，你可以這樣做，如果你想，但它不是瓜分你的代碼的可靠方法。

來源

2009-07-24 08:53:36

我建議刪除這些行註釋。他們只干擾事情。空白是更有效的海事組織，因爲它在視覺上設置了代碼塊，並且不會弄亂源代碼。

來源

2009-07-24 09:51:52 duffymo

我傾向於找到像你的榜樣的那些爲眼睛紅腫的意見。如果你正在分組你的內部類，那就夠了。沒有理由產生額外的噪音。此外，任何可尊重的IDE（Eclipse，IntelliJ等）都會爲您列出，過濾和分組代碼的結構元素。

來源

2009-07-24 10:02:05 Jataro

要回答你的問題，我不認爲有任何這樣的約定。

太陽的Code Conventions for Java當然沒有提到這樣的事情。

我的建議很簡單不要做。在我的項目中，我們只需在類型級別提供格式正確的JavaDoc註釋，並在關鍵API方法（主要是接口上的公共方法）上提供方法級別的JavaDoc，以及特定實現足夠特殊時需要記錄的具體方法。

這是我認爲初級開發人員（包括我自己）喜歡做的事情，但後來才意識到這是一個額外的負擔，並不能真正增加那麼多的價值。

來源

2009-07-24 11:17:02

我知道沒有普遍接受的章節分隔符的約定。有些人喜歡他們（我碰巧是他們中的一員），另一些人則認爲他們是不必要的分心。這兩個羣體都不是對與錯：不幸的是，這對於一些開發者來說可能會成爲一個近乎宗教的問題（不同於編輯的選擇，語言的選擇等），這是個人品味的問題。

我認爲重要的是要與其他開發者保持一致和尊重，特別是在沒有項目範圍標準的情況下。如果您不是某個文件的主要維護者，但需要在其中進行更改，請儘量遵循已有的格式。

來源

2009-07-24 13:18:59

清除代碼並刪除不必要的註釋。代碼應該說明它自己做了什麼，記錄公共類/接口，構造函數&作爲API的一部分的方法，使其清晰和簡潔/簡短。

來源

2009-07-24 18:22:32

是否有一個「行規」的Java

回答

相關問題