幾條關於java程序設計風格的指導性建議

  • 正確的註釋和註釋風格

        在程序的開頭寫一個總結,介紹每一個主要步驟並解釋每個難以讀懂之處。註釋寫得簡明扼要是很重要的,不能讓整個程序都充滿註釋而使程序很難讀懂。
        使用javadoc註釋(/**……*/)來註釋整個類,或整個方法。爲了將這些註釋提取出來放在一個javadoc Html文件中,這些註釋必須放在類或者方法頭的前面。要註釋方法中的某個步驟,使用行註釋(//)。


  • 正確的縮進和空白

        保持一致的縮進風格會使程序更加清晰、易讀、易於調試和維護。
        在嵌套結構中,每個內層的組成部分或語句應該比外層縮進兩格。二元操作符應該各加一個空格,例如:

System.out.println(3 + 4 * 4);



  • 塊的風格

        塊是由花括號圍起來的一組語句。塊的寫法有兩種常用方式:次行風格和行尾風格。
    例如:

next-line:

public class Test
{
  public static void main(String[] args)
  {
    System.out.println("Block Styles");
  }
}


end-of-line:

public class Test{
  public static void main(String[] args){
    System.out.println("Block Styles");
  }
}


    次行風格將花括號垂直對齊,因而使程序容易閱讀,而行尾風格更節省空間,並有助於避免犯一些細小的程序設計錯誤。
    代碼內應統一採用一種風格,建議不要將兩種風格混合使用。

——《java語言程序設計基礎篇》

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章