iB2Team專案開發規範

By KevinLee 2016-4-20
僅供參考

1. 目的

為了使軟體開發過程順暢，保證軟體質量，於是有了這份開發規範文件。

2. 概述

• 專案以功能模組來劃分分工
• 資料庫不能隨意修改，本地資料庫須統一
• 有標準的Java程式碼風格，有良好習慣
• 時刻考慮程式碼的可複用性
• 每個人需要有每週專案進度報告

3. 程式碼規範

3.1 有關命名

儘量保證能夠通過變數名得知變數的含義

3.1.1 包命名

• 包命名採用全小寫命名
• 通過唯一域名+元件來命名

3.1.2 類命名

• 類命名採用Pascal命名法
• 大寫字母開頭，各個單詞首字母大寫

3.1.3 方法命名

• 方法命名採用Camel命名法
• 小寫字母開頭，各個單詞首字母大寫
• 屬性的getter和setter方法儘量使用自動生成，並放在程式的後面。
• Boolean型別的屬性的get方法應形如isProperty()

3.1.4 變數命名

• 採用Camel命名法
• 小寫字母開頭，各個單詞首字母大寫
• 特有大寫縮寫詞彙保持大寫如：SQL
• 變數名字不宜過長，可適當採用縮減英文母音字母來縮短長度
• 假如縮短後名字重複，可以保留其中一個的部分母音字母

3.1.5 常量命名

• 採用全大寫命名法
  所有字母均大寫

3.1.6 頁面檔案命名

• 採用全小寫命名法
• 所有的字母均小寫，單詞之間以下劃線’_’分隔
• 展示頁面，按照名詞+描述，如：news_list.jsp
• 操作頁面，按照名詞+動詞命名，如：news_add.jsp
• 按照模組從大到小命名，如：news_order_add.jsp

3.1.7 資原始檔命名

• 採用全小寫命名法
• 按照字首+模組+描述+狀態命名，如：btn_main_login_pressed.png
• (不一定完全包含如上4個部分，但是要依照順序命名)

3.2 有關注釋

團隊成員都應該形成良好的寫註釋的習慣，方便以後閱讀，以及為了後期生成可讀性良好的Java Doc

3.2.1 程式檔案頭註釋

應該包含如下：
* 檔案描述
* 作者
* 版本
* 建立日期時間
* 修改日期時間
* 參考資訊

提前設定好檔案的模板Template
如以下模板：

/**
 * Description: 
 * Author: KevinLee
 * Version: 1.0
 * Create Date Time: ${DATE} ${TIME}.
 * Update Date Time: 
 * @see 
 */

3.2.2 方法頭註釋

一般在寫完一個方法後使用快捷鍵生成一個塊註釋，IDE會自動幫我們寫入一些資訊。
應該包含如下資訊：
* 方法描述 Description:
* 引數資訊 @param
* 返回資訊 @return
* 異常資訊 @Exception
* 參考資訊（可選）@see also //指定一個類或者方法（通過類後面加#選擇方法）
* 筆記資訊（可選）Note:
如以下模板：

/**
 * Description: 返回一個“Hello”字串
 * @param str 一個字串
 * @return 返回一個字串
 * @throws Exception  丟擲一個異常
 * @see com.lidengju.entity.Person
 * Note: Nothing much.
 */
public  String  sayHello(String  str) throws  Exception{
    str="Hello";
  return  str;
}

注意：方法裡面不要使用塊註釋

3.2.3 關鍵點註釋

應該包含如下資訊：
* 一些程式關鍵的地方
* 一些程式不易讀的地方
* 編寫程式碼過程中遇到問題的地方
* 需要提示讀者的地方

註釋應該寫得少而易懂
若修改了檔案，可以加上修改人的資訊，和修改日期。

4. 格式規範

4.1 縮排

應注意使用format來格式化程式碼，使用Tab鍵來縮排程式碼，相當於4個空格。

4.2 換行

• {}花括號應該另起一行，左花括號與方法名、類名在同一行。(除了陣列初始化時的花括號)
• if、while等語句，假如體內只有一句程式碼也不要省略{}，為了方便以後的增刪
• 字串過長考慮拆分成多行

4.3 對齊

• {}括號等應該對齊
• 類和方法的塊註釋必須緊貼類和方法
• 單獨起行的//註釋必須對齊被註釋語句

5. 寫在後面

希望各位成員遵守這份開發規範文件，養成良好的開發習慣