資源描述:
《Java語言編碼規(guī)范JavaCodeConventions》由會員上傳分享,免費在線閱讀,更多相關內(nèi)容在工程資料-天天文庫。
1、Java語言編碼規(guī)范一、包命名方式(全部小寫)com.sc.系統(tǒng)名.模塊名.層次名.子層次名,例:com.sc.mfab.master.domin.facade二、JAVA類文件命名(JAVAClassFileNames)1Action命名標準機能ID+“Action”,例:FN00001Action.java2Dao命名標準接口:表名4-“Dao”,例:TbUserDao.java實現(xiàn):表名+“Daolmpl”,例:TbUserDaoImpl.java3Facade命名標準Fagade文件按照模塊劃
2、分。接口:模塊名+“Facade”,例:MasterFacade.java實現(xiàn):模塊名+“FacadeImpl”,例:MasterFacadelmpl.java(Facade文件如果較大(預計會超過2000行)可以按照子模塊劃分)4ActionForm命名標準畫面ID+“Form”,例:PN0001Form.java5POJO命名標準對應表名+“Bean”,例:UserBean.java6常量類命名標準模塊名4-“Constants”,例:MasterConstants.java全系統(tǒng)常量類名:Com
3、monConstants.java7Util類命名標準工具名+“Utils”,例:StringUtils.java包名:com.sc.utils.StringUtils.java8common包放與項目相關的共同方法。例:com.sc.?H名.common三、類中變量和方法命名1變量命名方式多個名詞組合,第一個名詞首字母小寫,其他名詞首字母大寫。例:userName,objectFactory,entrys,userList2常量命名方式多個名詞組合,全部大寫,屮間加下劃線,例:MAX_TIMES,D
4、EFAULT_NAME3方法名命名方式和變量命名方式相同,例:selectUserName();getUserName();insertUserName();updateUserName();deleteUserName();4臨時變量循環(huán):i,j,k....Int,long...注意點:在定義JAVABEAN中的變量類型的時候,盡量用類而不是基本數(shù)據(jù)類型。如果定義了基本數(shù)據(jù)類型從數(shù)據(jù)庫返回的值為NULL賦值給這個數(shù)據(jù)的BEAN的話會報錯。四、JAVA文件組織(FileOrganization)一個文
5、件由被空行分割而成的段落以及標識每個段落的可選注釋共同組成。超過2000行的程序難以閱讀,應該盡量避免。”Java源文件范例”提供了一個布局合理的Java程序范例。1開頭注釋(BeginningComments)所有的源文件都應該在開頭有一個C語言風格的注釋,其中列出類名、版本信息、口期和版權聲明:/**Classname**Versioninformation*author*Date*Copyrightnoticc*/類名稱版本信息(修改歷史)作者建立吋間版權信息2包和弓I入語句(Packagean
6、dImportStatements)在多數(shù)Java源文件中,第一個非注釋行是包語句。在它之后可以跟引入語句,引入類文件盡量粘確到類名。例如:packagejava,awt;importjava.awt.peer.CanvasPeer;避免使用如下:importjava.awt.peer.*;3類開始注釋/***描述Java類的作用*/4方法注釋/***描述方法的作用*/五、排版和注釋(Indentation)4個空格常被作為縮進排版的一個單位??s進的確切解釋并未詳細指定(空格vs.制表符)。一個制表符
7、等于8個空格(而非4個)。1行長度(LineLength)盡量避免一行的長度超過80個字符,因為很多終端和工具不能很好處理之2換行(WrappingLines)當一個表達式無法容納在一行內(nèi)時,可以依據(jù)如下一般規(guī)則斷開之:-在一個逗號后面斷開-在一個操作符前面斷開?寧可選擇較高級別(higher-level)的斷開,而非較低級別(lower-level)的斷開-新的一行應該與上一行同一級別表達式的開頭處對齊?如果以上規(guī)則導致你的代碼混亂或者使你的代碼都堆擠在右邊,那就代Z以縮進8個空格。以下是兩個斷開算
8、術表達式的例子。前者更好,因為斷開處位于括號表達式的外邊,這是個較高級別的斷開。例:IongNamel二IongName2*(longName3+longName4-longName5)+4*longname6;//PREFFERlongNamel=longName2*(longNamc3+longName4-longName5)+4*longnanie6;3布局(Placement)原則是簡單易讀,布局的時候可以選擇你要布局的代碼使用Eclipse的快