Java软件项目开发命名规范_命名规则
文章目錄
- 一、項目命名/包命名/虛擬目錄/資源路徑
- 二、Java 代碼命名
- 三、屬性文件 properties 命名
- 四、xml文件命名
- 五、jsp文件命名
- 六、html文件命名
- 七、js文件命名
- 八、css文件命名
- 九、圖片文件命名
- 十、數據庫命名
- 十一、html 標簽的屬性值命名規則
- 總結
一、項目命名/包命名/虛擬目錄/資源路徑
項目名稱使用英文,全部字母小寫,單詞之間使用連接線 - 。如 :student-management
包名稱使用英文,全部字母小寫,通常都是一個單詞,詞性是名詞,如果需要多個單詞,單詞之間使用下劃線。
虛擬目錄,使用英文,全部字母小寫,如果需要多個單詞,單詞之間使用下劃線。
資源路徑,使用英文,全部字母小寫,如果需要多個單詞,單詞之間使用下劃線。
二、Java 代碼命名
1、包名:包名統一使用小寫,點分隔符之間有且僅有一個自然語義的英語單詞。包名統一使用單數形式,例如:com.htlwk.qpw.util。
2、類名:PascalCase 命名法,帕斯卡命名法,又稱之為 UpperCamelCase,大駝峰式命名法 ,每一個單詞的首字母都大寫,類名如果有復數含義,類名可以使用復數形式,例如:SimpleDataFormat、MessageUtils
3、方法名:Camel 命名法,駱駝式命名法,又稱之為 lowerCamelCase,小駝峰式命名法。混合使用大小寫字母,即多個單詞的情況下,第一個單詞首字母小寫,其余單詞首字母均大寫。方法名一般采用動詞+名詞或動詞表示,如 append()、getName()、printStackTrace() 等。
4、變量名(對象名):和方法名一樣的規范,一般采用名詞或形容詞+名詞的形式表示。
5、屬性名:和變量名一樣的規范,一般采用名詞或形容詞+名詞的形式表示。如 name、dbClassName、dbUser、dbPassword、dbUrl 等。
6、常量名:下劃線命名法,UnderScoreCase,全部大寫,單詞之間加下劃線,例如:MAX_PRIORITY。
三、屬性文件 properties 命名
全部小寫,標準縮寫大寫,單詞之間加下劃線
例如:errors_zh_CN.properties,hibernate_test.properties
四、xml文件命名
全部小寫,單詞之間加連接號 -,我建議使用下劃線 _
五、jsp文件命名
全部小寫,單詞之間加連接號 -,我建議使用下劃線 _
六、html文件命名
全部小寫,單詞之間加連接號 -,我建議使用下劃線 _
七、js文件命名
全部小寫,單詞之間加連接號 -,我建議使用下劃線 _
八、css文件命名
全部小寫,單詞之間加連接號 -,我建議使用下劃線 _
九、圖片文件命名
全部小寫,單詞之間加連接號 -,我建議使用下劃線 _
十、數據庫命名
mysql數據表名:Camel命名法,單詞之間加下劃線,全部小寫。控制在30個字符內。舉例:country_language
mysql數據庫名:同表名一樣
mysql表字段名:同表名一樣
oracle數據表名:Camel命名法,單詞之間加下劃線,全部大寫。舉例:COUNTRY_LANGUAGE
oracle數據庫名:同表名一樣
oracle表字段名:同表名一樣
主鍵約束命名:約束類型+表名+字段名。舉例:pk_dept_deptno
視圖命名:v+表名。例如:v_student_major
索引命名:idx+表名+列名。例如:idx_student_name
十一、html 標簽的屬性值命名規則
html 標簽的 id 屬性值和 class 屬性值的命名規則:單詞之間使用連接號。
例如:div-right
也有很多項目使用下劃線,參考大廠的開發習慣,使用連接號比較多。
name 屬性值的命名規則:首字母小寫,后面的單詞首字母大寫。
總結
1、文件名稱中什么時候使用連接號 -,什么時候使用下劃線 _ 呢?
答:目錄的名稱中單詞之間通常使用連接號 - 隔開,所以你會發現工程名、模塊名、包名(jar/rar/zip 等)基本都是在單詞之間使用 - 隔開。而文件的名稱中單詞之間通常使用下劃線 _ 隔開,比方說腳本文件(js/sql 等)、標記文件(xml/html 等)、樣式表單文件(css)、屬性文件(Properties)等在命名時,單詞之間都是使用下劃線 _ 隔開。
總結
以上是生活随笔為你收集整理的Java软件项目开发命名规范_命名规则的全部內容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: 人间值得是什么意思
- 下一篇: 关于星辰的网名116个