您好,登錄后才能下訂單哦!
java代碼規范的作用是什么,針對這個問題,這篇文章詳細介紹了相對應的分析和解答,希望可以幫助更多想解決這個問題的小伙伴找到更簡單易行的方法。
代碼規范有什么意義
1.一個軟件的生命周期中,80%的花費在于維護,代碼規范降低了金錢成本和時間成本;
2.幾乎沒有任何一個軟件,在其整個生命周期中,均由最初的開發人員來維護,代碼規
范減少了工作交接過程中的交流成本。
3.規范可以改善軟件的可讀性,可以讓程序員盡快而徹底地理解新的設計和代碼,節約
了時間,提高了工作效率。
4.良好的編碼規范可以有效避免一些低級錯誤,贏得同事的夸獎和上司的認可。個人經歷
我在前段時間由于一級考試任務比較繁多,所以卓腦這邊的項目需要交接一下,然后我就簡單的跟她們溝通一下我負責的模塊,之后她們找過我幾次,因為的代碼有好多沒寫注釋,導致她們沒有看懂。MT4實際操作http://www.gendan5.com/operation.html所以如果我能把每行代碼都寫上注釋,能做到代碼規范,將會減少交接過程中的交流成本,還能節省出更多時間,學習其它的內容。
命名規范
1.名字應該能夠標識事物的特性,并且與業務掛鉤。
2.名字一律使用英文單詞,而不能為拼音。
3.名字可以有兩個或三個單詞組成,但不應多于4個,控制在3至30個字母以內。
4.在名字中,多個單詞用大寫第一個字母(其它字母小寫)來分隔。例如:IsSuperUser。
5.命名避免和以下關鍵字沖突
如:Base,Date,Class……
6.方法名、參數名統一使用駝峰命名法(Camel命名法),除首字母外,其他單詞的首字
母大寫,其他字母小寫,類名每個組合的單詞都要大寫;
正例:localValue/getHttpMessage()/inputUserId注釋規范
1.一般情況下,源程序的有效注釋量必須在30%以上。
2.避免使用裝飾性內容,保持注釋的簡潔。
3.注釋信息不僅要包括代碼的功能,還應給出原因,不要為注釋而注釋。
4.除變量定義等較短語句的注釋可用行尾注釋外,其他注釋當避免使用行尾注釋。
5.注釋類型:javadoc注釋,失效代碼注釋(eclipse下ctrl+shift+/),代碼細節注釋//。
6.對類、方法、變量等的注釋需要符合JavaDoc規范,對每個類、方法都應詳細說明其
功能、條件、參數等,并使用良好的HTML標記
7.格式化注釋,以使生成的JavaDoc易閱讀和理解。
8.如果注釋太復雜說明程序需要修改調整,使設計更加合理。
9.getter、setter方法不用注釋
10.注釋不能嵌套
11.生成開發文檔的需要用中文編寫
12.如果需要注釋的內容太多,需附加文檔進行說明,注釋時加上"參見《****》"
13.距離較遠的}必須注釋
14.復雜的分支流程必須注釋
15.代碼質量不高但能正常運行,或者還沒有實現的代碼用//TODO:聲明
16.存在錯誤隱患的代碼用//FIXME:聲明語句規則
原則:1.統一使用Eclipse格式化工具進行格式化,默認快捷鍵:Ctrl+Shift+F
2.盡量避免強制類型轉換。如果不得不做類型轉換,盡量用顯式方式。
3.Ifelse中的業務代碼行數太長,否則就要考慮用函數封裝
4.避免在表達式中用賦值語句
5.避免對浮點類型做等于或不等于判斷
6.杜絕魔法數字,for循環的最大數等也要用變量代替,以便知道是什么含義
7.對象比較運算,常量放在前面,比如"aaa".equals(str)
8.Boolean的"假"判斷格式:if(false==isMax)而不用if(!isMax),因為非符號"!"不
清晰
9.如果一段帶有業務邏輯的代碼超過兩次用到,就將其封裝成一個方法
10.單個循環也要用{}
11.每個變量僅有一個唯一的用途
12.單個函數執行單個功能并與其命名相符
13.消除所有編譯器警告
14.常數變量聲明為final
15.每個if-elseif-else語句都有最后一個else以確保處理了全集
16.對于流操作代碼的異常捕獲有finally操作以關閉流對象,比如:17.對同步對象的遍歷訪問必須進行代碼同步處理
18.在對Map對象使用迭代遍歷過程中保證沒有做增減元素操作
19.Ifelse判斷語句避免頭重腳輕,比如if的代碼段過大,else的代碼很短,這時候要調
整結構。
20.每一行最多包含一條語句。循環語句:
1.務必檢查,杜絕死循環
2.即使循環體只有一條語句,也要用花括號括起
3.盡量不用空語句,特殊情況用到空語句,寫好注釋,告訴讀者這不是bug
4.循環中禁止使用訪問數據庫的操作,循環內部如果需與數據庫交互,而應提前一次性
讀取出。
比如:Switch-case
1.語句switch中的每個case各占一行。
2.所有的非空case語句必須用break;語句結束。例:3.語句switch中的case按字母順序排列。
4.為所有switch語句提供default分支。編碼風格規則
編碼過程中需遵循以下風格習慣:
1.代碼未寫,文檔先行,注釋必須按照固定統一范式撰寫。
2.關系運算必須常量在左、變量在右。
3.不許使用復雜的運算表達式,必要時添加括號而不依賴于優先級。
4.局部變量必須初定義、避免不必要的內存操作、內存操作必須考慮異常處理。
關于java代碼規范的作用是什么問題的解答就分享到這里了,希望以上內容可以對大家有一定的幫助,如果你還有很多疑惑沒有解開,可以關注億速云行業資訊頻道了解更多相關知識。
免責聲明:本站發布的內容(圖片、視頻和文字)以原創、轉載和分享為主,文章觀點不代表本網站立場,如果涉及侵權請聯系站長郵箱:is@yisu.com進行舉報,并提供相關證據,一經查實,將立刻刪除涉嫌侵權內容。