前言
作爲一名程序員,瞭解代碼的規範是必要的。代碼規範不僅提高了我們的工作效率,也減少了工作交接過程中的交流成本。
代碼規範主要構成
命名規範
名字應該能夠標識事物的特性,並且與業務掛鉤。
名字一律使用英文單詞,而不能爲拼音。
名字可以有兩個或三個單詞組成,但不應多於4個,控制在3至30個字母以內。
在名字中,多個單詞用大寫第一個字母(其它字母小寫)來分隔。例如:IsSuperUser。
命名避免和以下關鍵字衝突
如:Base,Date,Class……
方法名、參數名統一使用駝峯命名法(Camel命名法),除首字母外,其他單詞的首字母大寫,其他字母小寫,類名每個組合的單詞都要大寫;
正例:localValue/getHttpMessage()/inputUserId
註釋
單行註釋:“//……”
塊註釋:“/……/”
文檔註釋:“/**……/”
修改代碼註釋:
頁面註釋:
在部分視圖等內容前添加註釋,保證代碼的可讀性:
如:顯式註釋:在html中存在註釋:
隱式註釋:可以使用java中的“//”、“/….*/”,以及JSP中自己的注 釋:“<%-- 註釋內容 --%>”
<%–
-創建人
-創建時間
-版本號
-文件名
-備註
-修改人
--%>
格式
- 採用eclipse作爲開發工具,編碼風格總體和eclipse編碼風格一致。
- 寫代碼時,不必特意設定空格、對齊等;寫完一個方法或一個類後,用eclipse的格式化工具完成格式化即可,快捷鍵:CTRL+Shift+F
- 注意: Eclipse格式化工具默認會進行空格、縮進排版,會自動在兩個函數間加入空行,但不會自動修改函數體內的空行——即:函數
- 體內語句間如果需要空行,則要手工加入。