Java基礎之 規範篇

引言

在我們的Java學習中,可能有很多人寫的代碼都能實現功能,但是不是那麼規範,爲什麼規範那麼重要呢。
首先,最直接的就是美觀了,有規範的代碼看起來賞心悅目,沒有規範的代碼看起來一團亂糟糟的,讓人看都不想看;
第二,就是對於之後代碼的維護了,如果出現bug,要修改代碼時,規範的代碼改起來會輕鬆一些,沒有規範的代碼改起來心情就不是那麼美妙了。
所以,我們的代碼一定要寫得規範,我們對待代碼要像對待一件藝術品一樣,使他儘可能的好看。

一、強制要求系列

1、包名

①使用小寫字母,例如com.xxx.set
②其中com是公司域名後綴,xxx是公司名稱,set是表達包的內容的含義的英文

2、文件名即類名

①必須使用帕斯卡命名法,即每個單詞的首字母大寫,例如:BigBoy
②文件名不能隨意取,必須是能夠表達文件所要做的事的英文

3、變量名

①必須使用駝峯命名法,即第一個單詞的首字母小寫,後面的單詞的首字母大寫,例如:bigBoy

4、方法名

①必須使用駝峯命名法,例如:getName()
②動詞在前,例如getName(),而不要nameGet()
③動詞前綴往往表達特定的含義,如下表:
前綴名 意義 舉例
create 創建 createOrder()
delete 刪除 deleteOrder()
add 創建,暗示新創建的對象屬於某個集合 addPaidOrder()
remove 刪除 removeOrder()
init或則initialize 初始化,暗示會做些諸如獲取資源等特殊動作 initializeObjectPool
destroy 銷燬,暗示會做些諸如釋放資源的特殊動作 destroyObjectPool
open 打開 openConnection()
close 關閉 closeConnection()<
read 讀取 readUserName()
write 寫入 writeUserName()
get 獲得 getName()
set 設置 setName()
prepare 準備 prepareOrderList()
copy 複製 copyCustomerList()
modity 修改 modifyActualTotalAmount()
calculate 數值計算 calculateCommission()
do 執行某個過程或流程 doOrderCancelJob()
dispatch 判斷程序流程轉向 dispatchUserRequest()
start 開始 startOrderProcessing()
stop 結束 stopOrderProcessing()
send 發送某個消息或事件 sendOrderPaidMessage()
receive 接受消息或時間 receiveOrderPaidMessgae()
respond 響應用戶動作 responseOrderListItemClicked()
find 查找對象 findNewSupplier()
update 更新對象 updateCommission()
find方法在業務層儘量表達業務含義,比如 findUnsettledOrders(),查詢未結算訂單,而不要findOrdersByStatus()。 數據訪問層,find,update等方法可以表達要執行的sql,比如findByStatusAndSupplierIdOrderByName(Status.PAID, 345)
————————————————
版權聲明:方法名部分爲CSDN博主「小紅威武」的原創文章,遵循CC 4.0 BY-SA版權協議,轉載請附上原文出處鏈接及本聲明。
原文鏈接:https://blog.csdn.net/HongEnIT/article/details/53466278

5、靜態常量

①必須全部大寫,單詞與單詞之間用“_”隔開

6、註釋

6.1 哪些部分需要註釋

①java文件:版權信息、創建時間、創建人
②類:目的、所完成的功能、版權信息、創建人
③方法:參數含義、返回值
④屬性:字段描述
⑤接口:目的、創建人、版本號、創建時間
⑥全局變量:字段描述

6.2 註釋規範

①單行註釋://註釋內容,一般與代碼後空4-8格,註釋必須對齊
②塊註釋:/註釋內容/
③文檔註釋:
/**
*註釋內容
*/

6.3 註釋標籤

@author 對類的說明 標明開發該類模塊的作者
@version 對類的說明 標明該類模塊的版本
@see 對類、屬性、方法的說明 參考轉向,也就是相關主題
@param 對方法的說明 對方法中某參數的說明
@return 對方法的說明 對方法返回值的說明
@exception 對方法的說明 對方法可能拋出的異常進行說明

二、建議規範部分

此部分只是建議這樣做,使代碼更好看

1、運算符號

“=”、“+”、“-”、“*”、“/”、“&&”、“||”等運算符號左右兩邊都打上空格,例如:a = 1;

2、逗號

逗號後面加空格,例如:add(1, 2)

感謝閱讀

這些規範只是一部分,後續會積累添加修改,同時也歡迎大家投稿,以及有錯誤的部分可以指出,共同學習,一起進步。

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章