java的命名規範

2021-08-09 22:52:06 字數 1582 閱讀 5149

命名規範

**中命名通常以英文單詞駝峰命名

,禁止使用拼音英文混合或使用中文方式,即使純拼音命名方式也應盡量避免採用【強制】

不得以下劃線或美元符號開始或結尾,反例:_name / $name / name_ / name$.

專案命名:

專案名稱由全英文小寫單詞組成,單詞間使用中劃線分隔,不宜過長大於15個字元時可適當使用縮寫,不得與其他專案衝突。示例:spring-webmvc;

包命名:

全英文小寫;

格式:產品所屬公司網域名稱反向+專案名+業務分層;如:com.ghgcn.activity(**創想公司活動系統專案),com.ghgcn.activity.dao。前3層為固定,第四層後根據專案自定。

類命名

a)全英文駝峰命名法,首字母大寫。大於15字元時允許使用縮寫。示例:hashmap;

c)抽象類,以base或abstract開頭。示例baseservice,abstractservice;

d)測試類以test結尾;

e)異常類以exception結尾。示例:dataacces***ception;

f)靜態工具類為以utils或helper結尾,優先使用utils有命名衝突時使用helper。示例:stringhelper,classutils;

- service層介面:實體名+service。示例:ishopuserservice;

- controller層:實體名+controller。示例:dictionarycontroller;

h) 介面實現類:實體名+serviceimpl,例如:dictionaryserviceimpl。

必須放於子包impl中;

j) 如果使用到了設計模式,建議在類名中體現出具體模式。【推薦】

示例: public class orde***ctory;public classloginproxy;

方法、變數、引數命名

a) 駝峰命名法,首字母小寫,力求語義表達完整清楚,盡量不使用縮寫;

不要與類成員變數同名(get/set方法與建構函式除外),變數與引數前不允許帶型別標識,反例: int icount / float fcount;

b) 布林型成員變數禁止以is開頭,因為布林型getter方法可以是is***(),可能導致異常;

c) 集合、陣列型別使用複數

示例:private string username;

private void createbean(string beanname);

private boolean success;

private listusers;

常量命名

常量命名全部大寫,單詞間用下劃線隔開。示例:final int max_count=1;

檔案命名

檔案及資料夾均使用小寫字母命名,單詞間以下劃線_分隔;

頁面按照名詞+動詞/描述命名,如news_add.jsp/ news_list.jsp

Java 命名規範

專案名全部小寫 包名全部小寫 類名首字母大寫,如果類名由多個單詞組成,每個單詞的首字母都要大寫 變數名 方法名首字母小寫,如果名稱由多個單詞組成,每個單詞的首字母都要大寫 常量名全部大寫 所有命名規則必須遵循以下規則 類注釋 在每個類前面必須加上類注釋屬性注釋 在每個屬性前面必須加上屬性注釋方法注釋...

Java包的命名規範

indi 個體專案,指個人發起,但非自己獨自完成的專案,可公開或私有專案,版權主要屬於發起者。包名為indi.發起者名.專案名.模組名 pers 個人專案,指個人發起,獨自完成,可分享的專案,版權主要屬於個人。包名為pers.個人名.專案名.模組名 priv 私有專案,指個人發起,獨自完成,非公開的...

java編碼規範 空白和命名規範

1.空白 white space 7.1空行 blank lines 空行將邏輯相關的 段分隔開,以提高可讀性。下列情況應該總是使用兩個空行 乙個原始檔的兩個片段 section 之間 類宣告和介面宣告之間 下列情況應該總是使用乙個空行 兩個方法之間 方法內的區域性變數和方法的第一條語句之間 塊注釋...