1提高編碼質量,程式碼可讀性和可維護性。
2程式碼編寫規範
2.2 必須給程式碼添加註釋,一個類的註釋字數不得小於程式碼的百分之20%
2.3 建議遵循30秒原則。如果另一個程式設計師無法在三十秒內無法知道你的函式在做什麼,如何做以及為什麼要這樣做,那麼說明你的程式碼是難於維護的,需要得到提高。
2.4 一個函式的程式碼長度不允許超過100行,超過一百行的函式建議在不破壞原子性的基礎上進行拆分。
2.5 變數都應在方法或者類的頭部集中定義
2.6 保證一行程式碼只做一件事
2.7 使用括號來控制運算子的運算順序,以免使用java預設的運算子優先順序順序。
2.8 程式碼格式化:對程式碼進行格式化,再進行提交。
2.9 介面不允許沒有方法或者變數的宣告
3. 命名規範
3.1 各種識別符號的命名要使用有實際意義的英文單詞或者英文單詞縮寫,縮寫詞及英文單詞要收錄在專案的簡寫詞彙表中。切忌使用阿拉伯數字和拼音進行命名。
3.2 類名:首字母大寫,每個單詞首字母都需要大寫。
3.3 方法名:首字母小寫,其餘單詞首字母都需大寫。
3.4 全域性變數,和常量名稱要求全部字母大寫。
3.5 引數名稱與區域性變數基本相同,區別在於引數名稱需要加上冠詞a ,an 或者在單詞結尾以s結束。
4. 註釋規範
4.1 註釋需要注意的事項:
4.2 類的註釋
標準格式:
如果對已經版本話的類進行了修改,需要按照如下格式為每一次修改附加修改歷史記錄:
// 修改人 + 修改日期
// 修改說明 範例:
// 李四 2010/07/02
// 新增錯誤資料修改後繼續批次儲存的處理函式 saveBatch(
@Bind(key = "itemParams", defaultValue = "") String itemParams,
@Bind(key = "pid", defaultValue = "") String pid)。
// 王小二 2010/07/02
4.3 介面註釋:
4.4 函式的註釋
4.5類屬性的註釋:
1提高編碼質量,程式碼可讀性和可維護性。
2程式碼編寫規範
2.2 必須給程式碼添加註釋,一個類的註釋字數不得小於程式碼的百分之20%
2.3 建議遵循30秒原則。如果另一個程式設計師無法在三十秒內無法知道你的函式在做什麼,如何做以及為什麼要這樣做,那麼說明你的程式碼是難於維護的,需要得到提高。
2.4 一個函式的程式碼長度不允許超過100行,超過一百行的函式建議在不破壞原子性的基礎上進行拆分。
2.5 變數都應在方法或者類的頭部集中定義
2.6 保證一行程式碼只做一件事
2.7 使用括號來控制運算子的運算順序,以免使用java預設的運算子優先順序順序。
2.8 程式碼格式化:對程式碼進行格式化,再進行提交。
2.9 介面不允許沒有方法或者變數的宣告
3. 命名規範
3.1 各種識別符號的命名要使用有實際意義的英文單詞或者英文單詞縮寫,縮寫詞及英文單詞要收錄在專案的簡寫詞彙表中。切忌使用阿拉伯數字和拼音進行命名。
3.2 類名:首字母大寫,每個單詞首字母都需要大寫。
3.3 方法名:首字母小寫,其餘單詞首字母都需大寫。
3.4 全域性變數,和常量名稱要求全部字母大寫。
3.5 引數名稱與區域性變數基本相同,區別在於引數名稱需要加上冠詞a ,an 或者在單詞結尾以s結束。
4. 註釋規範
4.1 註釋需要注意的事項:
4.2 類的註釋
標準格式:
如果對已經版本話的類進行了修改,需要按照如下格式為每一次修改附加修改歷史記錄:
// 修改人 + 修改日期
// 修改說明 範例:
// 李四 2010/07/02
// 新增錯誤資料修改後繼續批次儲存的處理函式 saveBatch(
@Bind(key = "itemParams", defaultValue = "") String itemParams,
@Bind(key = "pid", defaultValue = "") String pid)。
// 王小二 2010/07/02
4.3 介面註釋:
4.4 函式的註釋
4.5類屬性的註釋: