加強個人Java編程規範

來源:互聯網
上載者:User

  1. 命名規範

  2. 變數定義
    用int[] packets,永遠不要用 int packets[]形式

  3. 代碼編寫
    樣式推薦用unix格式——斷行符號+換行
    javadoc文檔化
    縮排2個字元(不要用tab,避免不同的代碼管理工具tab設定不同)
    不加無意思的括弧,{  }分兩行
  4. 全域變數要有較詳細的注釋,包括對其功能、取值範圍、哪些函數或過程存取它以及存取時注意事項等的說明。
  5. 注釋規範
    3種形式——//           注釋一行
                         /*……*/     注釋若干行
          /**……*/   文檔注釋,寫入javadoc   
    注釋放在上方或右方

    整個源檔案要有詳細的注釋
     
    每個函數前有必要的注釋

    javadoc注釋標籤文法:

    @author 對類的說明 標明開發該類別模組的作者 

    @version 對類的說明 標明該類別模組的版本

     @see 對類、屬性、方法的說明 參考轉向,也就是相關主題 

    @param 對方法的說明 對方法中某參數的說明 

    @return 對方法的說明 對方法傳回值的說明 

    @exception 對方法的說明 對方法可能拋出的異常進行說

  6. 函數
    保證每個參數的有確切含義。
    exit只能在main中被調用
    頂層的main應該截獲所有異常,並且列印到螢幕或記錄日誌
    如果不確定某類是否要被繼承,在文檔中註明,不輕易定義為final

  7. *. java檔案應該遵循的樣式(主要包含以下部分)

    版本資訊放在java檔案開頭,形式為(其他不要出現在javadoc中內容也可以包含其中)

    package放在import之前,import標準   放在  import本地 之前。

    類注釋

    類定義

    類成員變數(public 成員變數必鬚生成javadoc)

    存取方法(如果很簡單可以寫在同一行)

    建構函式

    類方法

    toString方法(每個類都應該有toString方法)

    main方法(如果有main方法,應寫在類的最底部)

  8. 注意一些效能
    不要再迴圈中構造變數 或 釋放變數

聯繫我們

該頁面正文內容均來源於網絡整理,並不代表阿里雲官方的觀點,該頁面所提到的產品和服務也與阿里云無關,如果該頁面內容對您造成了困擾,歡迎寫郵件給我們,收到郵件我們將在5個工作日內處理。

如果您發現本社區中有涉嫌抄襲的內容,歡迎發送郵件至: info-contact@alibabacloud.com 進行舉報並提供相關證據,工作人員會在 5 個工作天內聯絡您,一經查實,本站將立刻刪除涉嫌侵權內容。

A Free Trial That Lets You Build Big!

Start building with 50+ products and up to 12 months usage for Elastic Compute Service

  • Sales Support

    1 on 1 presale consultation

  • After-Sales Support

    24/7 Technical Support 6 Free Tickets per Quarter Faster Response

  • Alibaba Cloud offers highly flexible support services tailored to meet your exact needs.