[2018年最新整理]Java編碼規(guī)范

制定編碼規(guī)范的最主要的目的是為了對產(chǎn)出代碼的長期維護(hù)。通常負(fù)責(zé) 維護(hù)代碼的人大多都不是開發(fā)者本人，如果有一個(gè)統(tǒng)一的代碼格式以及 說明就可以減少混淆提高理解速度。 范圍 編碼規(guī)范定義了所有代碼編寫者在編寫Java代碼時(shí)應(yīng)遵守的一些規(guī) 則和習(xí)慣。 本規(guī)范采用以下術(shù)語描述： 規(guī)則：編程時(shí)強(qiáng)制必須遵守的原則。 建議：編程時(shí)必須加以考慮的原則。 示例：對此規(guī)則或建議給出例子。 2.1 文件體系規(guī)則 規(guī)則2.1.1 JSP文件目錄結(jié)構(gòu) |――cgi 存放cgi程序|――cgi-bin 存放cgi編譯后的程序|――css 存放樣式表 |――html 存放臨時(shí)生成的報(bào)表文件|――images 存放圖片|――include 存放系統(tǒng)要引用的文件|――js 存放javascript腳本 |――ocx 存放ocx控件 |――page 存放JSP頁面|――模塊分類名 |――WEB-INF WEB 配置文件，class 文件 2.1 文件體系規(guī)則 建議2.1.2 Java文件目錄結(jié)構(gòu) |――模塊分類 |――action 存放action(控制層)文件 |――dao 存放dao(數(shù)據(jù)層)文件 |――form 存放form(展示層)文件 |――service 存放業(yè)務(wù)邏輯文件 |――vo 存放數(shù)據(jù)對象文件 2.2 源文件結(jié)構(gòu)規(guī)則 規(guī)則2.2.1 包和引入語句 先寫包語句，再寫引入語句。 package行和import行之間留一行空行。 引入的標(biāo)準(zhǔn)包名要在本地包名之前，并且包名按照字母順序排列。 如果 import 行中包含了同一個(gè)包中的類超過5個(gè)，則用 * 來處理。 import的標(biāo)準(zhǔn)包和本地包之間留一行空行。 示例： 2.2 源文件結(jié)構(gòu)規(guī)則 規(guī)則2.2.2 類/接口 先寫類/接口注釋，標(biāo)明類/接口的用途、版本、作者等信息。 類/接口注釋之后空一行，然后寫類/接口聲明。 extends 和 implements寫在不同行。 異常也單寫一行。 示例： 2.2 源文件結(jié)構(gòu)規(guī)則 規(guī)則2.2.3 類變量的聲明順序是 public,protected,package,private 公共變量(Public) 保護(hù)變量(Protected) 包一級別的變量(沒有訪問修飾符) 私有變量(Private) 2.2 源文件結(jié)構(gòu)規(guī)則 規(guī)則2.2.4 變量、常量的注釋應(yīng)放在其上方相鄰位置或右方 規(guī)則2.2.5 用遞增的方式寫構(gòu)造器(比如：參數(shù)多的寫在后面) 規(guī)則2.2.6 類變量的存取方法：get和set方法 規(guī)則2.2.7 如果定義main() 方法，必須將main方法寫在類的底部 3.1 Struts配制文件命名 4.1 方法排版規(guī)則 規(guī)則4.1.1 方法名和其后的括弧之間不應(yīng)有空格 示例： 4.1 方法排版規(guī)則 規(guī)則4.1.3 在方法的局部變量聲明和語句之間加一個(gè)空行 示例： 4.1 方法排版規(guī)則 規(guī)則4.1.4 塊注釋或單行注釋之前必須有一行空行 規(guī)則4.1.5 方法內(nèi)的兩個(gè)邏輯段之間必須有一行空行 建議4.1.6 在方法的每個(gè)參數(shù)之間的逗號后面加一個(gè)空格 4.2 語句排版規(guī)則 規(guī)則4.2.1 簡單語句每行至多包含一條語句 示例： 4.2 語句排版規(guī)則 規(guī)則4.2.3 左大括號“{”應(yīng)位于復(fù)合語句起始行的行尾；右大括號“}”應(yīng) 另起一行并與復(fù)合語句首行對齊。 示例： 4.2 語句排版規(guī)則 規(guī)則4.2.4 必須用“{”和“}”將if內(nèi)的語句括起來。(即使只有一條語句 的情況下) 正確： 4.2 語句排版規(guī)則 規(guī)則4.2.5 在多層嵌套的if語句中，需以尾端注釋的方式表示出層次關(guān)系 4.2 語句排版規(guī)則 規(guī)則4.2.8 每當(dāng)一個(gè)case順著往下執(zhí)行時(shí)(因?yàn)闆]有break語句)，通常 應(yīng)在break語句的位置添加注釋。下面的示例代碼中就包含注釋 /* falls through */ 示例： 4.2 語句排版規(guī)則 建議4.2.9 大括號可以被用于所有語句，包括單個(gè)語句，只要這些語句是諸如if-else或for控制結(jié)構(gòu)的一部分 建議4.2.10 關(guān)鍵詞for和后面的括號之間加一個(gè)空格 建議4.2

《新程序員》：云原生和全面數(shù)字化實(shí)踐50位技術(shù)專家共同創(chuàng)作，文字、視頻、音頻交互閱讀

總結(jié)

以上是生活随笔為你收集整理的java编码ppt_[2018年最新整理]Java编码规范.ppt的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。