項目開發相關規範

標籤：項目規範

目錄規範

目錄規範——在開發中整體檔案夾組織圖。

1.Requirement——需求文檔檔案夾

2.Design——設計文檔檔案夾

3.Test——整合測試，系統測試，測試報告，測試資訊清單檔夾

4.Deployment——發布部署的檔案夾

5.Study——預研，學習資料的檔案夾

6.Src——源碼檔案夾

7.Help——協助文檔檔案夾

基本命名規範

1.變數使用駝峰法的規則命名，要加入首碼m，如：mUserNum;

2.常量使用全大寫字母標識，單詞間用底線隔開，如：USER_NAME；

3.類名使用首字母大寫，如：UserName；

4.方法名使用駝峰法的規則命名，不用加入首碼，如：getUserName；

5.介面名使用首字母大寫；

 

 

包名命名規範

1.包名一律首字母大寫, 少用縮寫；

2.包名結構：[項目名].[基本模組名].[具體模組名]

    如：com.example.View.UserModule

 

注釋

檔案，類或介面注釋

Ÿ所有的源檔案都應該在開頭有一個注釋，其中列出檔案的作者、時間、功能描述以及建立、修改記錄

 

/**

 *

 * @Description功能描述

 *

 * 版本號碼   作者   日期   相關修改

 * 1.0   linbin  2014-5-4 建立

 *

 * @authorlinbin

 *2014-5-4

 */

方法注釋

Ÿ所有的方法都應該在開頭有一個注釋，其中列出功能描述，所使用的參數說明，返回值說明

/**

  *  功能描述

  * @param參數說明

  * @return返回值說明

  */

  

注釋格式設定方法：

右鍵項目->Properties->Java CodeStyle->Comments 然後選擇對應項，進行模板的設定