???歡迎來到dream_ready的博客,??相信你對這兩篇博客也感興趣o?(ˉ▽ˉ;)
?? 表白墻/留言墻 —— 初級SpringBoot項(xiàng)目,練手項(xiàng)目前后端開發(fā)(帶完整源碼) 全方位全步驟手把手教學(xué)
?? 用戶登錄前后端開發(fā)(一個(gè)簡單完整的小項(xiàng)目)——SpringBoot與session驗(yàn)證(帶前后端源碼)全方位全流程超詳細(xì)教程
目錄
為什么代碼需要遵循命名風(fēng)格?
企業(yè)規(guī)范
包名 —— 統(tǒng)一小寫
類名 —— 大駝峰
方法名、參數(shù)名、成員變量、局部變量 —— 小駝峰
常量命名 —— 全部大寫
抽象類、異常類、測試類 —— 固定開頭或結(jié)尾
數(shù)據(jù)庫及其字段 —— 蛇形
css等 —— 串行
在JAVA中,有一些命名約定和風(fēng)格指南,以確保代碼的可讀性和一致性
為什么代碼需要遵循命名風(fēng)格?
????????想象一種場景,你到一個(gè)新的公司維護(hù)老項(xiàng)目,這個(gè)老項(xiàng)目里面的包名、類名、變量名定義的亂七八糟,甚至有中文,而你之前的公司都嚴(yán)格的遵守代碼規(guī)范,你一看到這個(gè)命名風(fēng)格就知道這段代碼是在干什么,這兩種情況你喜歡哪個(gè)呢?毋庸置疑是嚴(yán)格遵守代碼規(guī)范的項(xiàng)目
????????代碼命名風(fēng)格是一種最佳實(shí)踐,可以提高代碼的質(zhì)量、可維護(hù)性和可讀性,減少錯(cuò)誤和混淆,避免混亂和不必要的爭議
以下從細(xì)致入微的出發(fā)點(diǎn)解釋為什么代碼需要遵循命名風(fēng)格?
- ??????????可讀性:有意義的命名使代碼更容易理解。當(dāng)變量、函數(shù)和類的名稱清晰明了時(shí),其他開發(fā)人員(包括你自己將來)可以更快地理解代碼的功能和目的。
- ????????減少歧義:一致的命名風(fēng)格可以減少命名歧義。例如,在一個(gè)項(xiàng)目中,如果約定了使用駝峰命名法,那么其他開發(fā)人員會知道如何正確解釋和使用變量名。
- ????????易于維護(hù):清晰的命名風(fēng)格使代碼更易于維護(hù)。當(dāng)需要修改或添加新功能時(shí),有意義的名稱可以幫助開發(fā)人員更快地理解代碼,并減少錯(cuò)誤。
- ????????提高可搜索性:一致的命名風(fēng)格使代碼更容易搜索和查找。開發(fā)人員可以快速定位到特定的變量、函數(shù)或類,而無需查看大量代碼。
- ????????降低學(xué)習(xí)成本:新加入的團(tuán)隊(duì)成員或其他開發(fā)人員可以更快地適應(yīng)項(xiàng)目,因?yàn)樗麄兛梢愿鶕?jù)命名風(fēng)格來理解代碼。這降低了學(xué)習(xí)和適應(yīng)新代碼的成本。
- ????????代碼審查:在進(jìn)行代碼審查時(shí),清晰的命名風(fēng)格可以幫助審查者更容易發(fā)現(xiàn)潛在的問題或改進(jìn)點(diǎn)。
- ????????規(guī)范性:遵循一致的命名規(guī)則和風(fēng)格是項(xiàng)目開發(fā)的一部分,有助于維護(hù)團(tuán)隊(duì)的一致性和統(tǒng)一性,避免混亂和不必要的爭議。??
企業(yè)規(guī)范
????????首先、提一點(diǎn)、代碼中的所有命名嚴(yán)禁使用拼音與英文混合的方式,更不允許直接使用中文的方式
包名 —— 統(tǒng)一小寫
包名統(tǒng)一使用小寫,點(diǎn)分隔符之間有且僅有一個(gè)自然語義的英語單詞
? ? ? ? 比如應(yīng)用工具類包名為 ??com.alibaba.open.util???
????????我上面沒有包含點(diǎn)分隔符的包名,因?yàn)槲覍颊归_了(這樣子做的目的只是看著更舒服,也更好操作,但不強(qiáng)制),不展開的話如下:
解決包名合并問題 IDEA/idea 左側(cè)包名合并/在一起了 解決辦法,超實(shí)用
類名 —— 大駝峰
類名使用大駝峰風(fēng)格,但以下情形例外:DO/BO/DTO/VO/AO
? ? ? ? 大駝峰:所有單詞首字母都需要大寫,又叫帕斯卡命名法,比如UserController
? ? ? ? DO/BO/DTO/VO/AO等例外,比如 OrderVO、UserDTO:
方法名、參數(shù)名、成員變量、局部變量 —— 小駝峰
????????方法名、參數(shù)名、成員變量、局部變量統(tǒng)一使用小駝峰風(fēng)格
????????小駝峰:除了第一個(gè)單詞,其他單詞單詞首字母都大寫,比如 userController、??localValue 、?getHttpMessage() 、?inputUserId?
常量命名 —— 全部大寫
常量命名全部大寫,單詞間用下劃線隔開,力求語義表達(dá)完整清楚,不要嫌名字長
比如?MAX_STOCK_COUNT?
抽象類、異常類、測試類 —— 固定開頭或結(jié)尾
抽象類命名使用 ??Abstract??? 或 ??Base??? 開頭;異常類命名使用 ??Exception??? 結(jié)尾;測試類命名以它要測試的類的名稱開始,以 ??Test?? 結(jié)尾
數(shù)據(jù)庫及其字段 —— 蛇形
數(shù)據(jù)庫庫名、表名、字段名均采用蛇形命名法
蛇形:用下劃線(_)作為單詞間的分隔符,一般小寫(實(shí)際使用情況必須大寫),又叫下劃線命名法,比如:user_controller
css等 —— 串行
串行:用短橫線(-)作為單詞間的分隔符,又叫脊柱命名法,比如:user-controller文章來源:http://www.zghlxwxcb.cn/news/detail-735753.html
??歡迎您于百忙之中閱讀這篇博客,??希望這篇博客給您帶來了一些幫助,祝您生活愉快!文章來源地址http://www.zghlxwxcb.cn/news/detail-735753.html
到了這里,關(guān)于企業(yè)級JAVA、數(shù)據(jù)庫等編程規(guī)范之命名風(fēng)格 —— 超詳細(xì)準(zhǔn)確無誤的文章就介紹完了。如果您還想了解更多內(nèi)容,請?jiān)谟疑辖撬阉鱐OY模板網(wǎng)以前的文章或繼續(xù)瀏覽下面的相關(guān)文章,希望大家以后多多支持TOY模板網(wǎng)!