給自己規定了Java編碼規范。編寫Java代碼嚴格依照自己規定的格式。歡迎大家指出問題。

/* *COPYRIGHT */package com.triangle23.projectabbreviationname.modulename.??

?.???. ##1.全部字母都是用小寫，不要有特殊字符 ##2.組合單詞的每一個部分都寫全拼，連接時各個部分之間不要有特殊符號。組合單詞不要超過三個，每一個部分都用名詞。盡量用英文，中文的話用拼音 ##3.projectabbreviationname和modulename假設用中文詞組由拼音首字母組成，不要超過16個字母 import java.util.Date; import javax.annotation.Resource; import org.springframework.stereotype.Controller; import com.triangle23.?

??.ClassName; import com.triangle23.??

?.ClassName.methodName; import com.adrastos.?

??

.ClassName.methodName; ##1.引用的順序是Java核心包庫->Java擴展包庫->第三方開源類庫->自己或別的公司的類庫 ##2.引用時做到最小引用，即僅僅引入用到的最小范圍(如僅僅使用了某個類的某個方法，僅僅需引入該方法就可以) ##3.用空白行區分不同類別的引用 /** *Description: * * *@author triangle23.lzl@gmail.com *@version number(1.0), date * *Revision History: * <who> <when> <what> * ???

?

?? ?

?

? */ public class ClassName extends FatherClassName implements InterfaceName1, InterfaceName2{ ##1.類/接口名都應是名詞組成，且每一個單詞第一個字母均為大寫 /**static CONSTENT_NAME1的凝視*/ static final int CONSTENT_NAME1 = 1; /**static CONSTENT_NAME1的凝視*/ static final String CONSTENT_NAME2 = "Hello World!"; ##1.常量的定義放在最前面 ##2.常量的變量名有若干有意義單詞組成，每一個字母全部大寫，之間用"_"切割 /**static interfaceVar1的凝視*/ public static InterfaceName interfaceVar1; /**static interfaceVar2的凝視*/ protected static InterfaceName[] interfaceVar2; /**static interfaceVar3的凝視*/ private static InterfaceName interfaceVar3; /** *static interfaceVar4的凝視 *超過兩行 */ public static InterfaceName interfaceVar4; /** *static interfaceVar5的凝視 *超過兩行 */ protected static InterfaceName[] interfaceVar5; /** *static interfaceVar6的凝視 *超過兩行 */ private static InterfaceName interfaceVar6; ##1.與前一級別的變量組之間留有一個空白行 ##2.多個接口聲明之間不留有空白行 ##3.變量名稱見通用規則 ##4.變量定義的順序是安可見性由大到小排列。由單個變量到數組變量 ##5.調用類中靜態接口變量須要使用ClassName.interfaceVar1，不能使用variableClassName.interfaceVar1 /**static classVar1的凝視*/ public static ClassName classVar1; /**static classVar2的凝視*/ protected static ClassName[] classVar2; /**static classVar3的凝視*/ private static ClassName classVar3; /** *static classVar4的凝視 *超過兩行 */ public static ClassName classVar4; /** *static classVar5的凝視 *超過兩行 */ protected static ClassName[] classVar5; /** *static classVar6的凝視 *超過兩行 */ private static ClassName classVar6; ##1.與之前的靜態接口變量之間留有一個空白行 ##2.變量名稱見通用規則 ##3.變量定義的順序是安可見性由大到小排列。由單個變量到數組變量 ##4.多個類聲明之間不留有空白行 ##5.調用類中靜態類變量須要使用ClassName.classVar1，不能使用variableClassName.classVar1 public static int variableName1; //凝視 protected static String[] variableName2; //凝視 private static long variableName3=1.0l; //凝視 ##1.與前一級別的變量組之間留有一個空白行 ##2.變量名稱見通用規則 ##3.變量定義的順序是安可見性由大到小排列。由單個變量到數組變量 ##4.多個靜態變量之間不留有空白行 ##5.假設僅僅是簡單的值，在聲明的時候就要賦值 ##6.變量到用的時候再賦值 ##7.調用類中靜態變量須要使用ClassName.variableName1，不能使用variableClassName.variableName1 public int variableName4; //凝視 protected String[] variableName5; //凝視 private long variableName6=1.0l; //凝視 ##1.與前一級別的變量組之間留有一個空白行 ##2.變量名稱見通用規則 ##3.變量定義的順序是安可見性由大到小排列。由單個變量到數組變量 ##4.多個實體變量之間不留有空白行 ##5.假設僅僅是簡單的值，在聲明的時候就要賦值 ##6.變量到用的時候再賦值 static{ } ##1.靜態代碼塊 ##2.與變量之間留有一個空白行 public ClassName(){ } protected ClassName(Object object){ } private ClassName(Object object, int variableName){ super.object = object; this.variableName = variableName; } ##1.構造函數依照可見級別進行分類，同樣可見級別之間依照參數個數排序 ##2.每一個構造函數之間都要留有一個空白行 ##3.當形參給類或父類的變量賦值時必須寫上super或者this ##4.類中使用自己的方法時必須用this.doMethodName()。調用父類的方法時用super.doMethodName() public int getVariableName6(){ return this.variableName6; } private void setVariableName6(int variableName6){ this.variableName6 = variableName6; } ##1.是否須要get和set方法看實際需求 ##2.注意get和set方法的可見性 ##3.同一個變量的get和set順序無所謂 ##4.注意get和set方法的名稱一定是get/setVariableName6，一般使用IDE生成 ####5.get和set方法的放置位置還沒有定，初定構造函數后面 /** *方法說明 * *@author authorName updateDate *@return returnType */ public static returnType doMethodName1(){ ##方法名稱的一個單詞應為動詞且首字母小寫后面組合單詞首字母大寫 int localVariableName1; //凝視 List<ClassName> localVariableName2; //凝視 String[] localVariableName3; //凝視 returnType returnTypeVariableName; ##1.注意局部變量盡量不要和上層變量重名 業務邏輯 for(int i = 0; i < count; ++i){ /**for循環條件說明*/ int forLocalVariableName1; //凝視 . . . 業務邏輯 } for(VariableType variableType : iteratorVariableName){ /**for循環條件說明*/ int forLocalVariableName1; //凝視 . . . 業務邏輯 } while(booleanEquation){ /**while條件說明*/ int whileLocalVariableName1; //凝視 . . . 業務邏輯 } do{ /**do while條件說明*/ int doWhileLocalVariableName1; //凝視 . . . 業務邏輯 }while(booleanEquation); if(booleanEquation){ /**if條件說明*/ int ifLocalVariableName1; //凝視 . . . 業務邏輯 }else if(booleanEquation){ /**else if條件說明*/ int elseIfLocalVariableName1; //凝視 . . . 業務邏輯 }else{ int elseLocalVariableName1; //凝視 . . . 業務邏輯 } switch(booleanEquation){ case NO.1: /**NO.1條件說明*/ 業務邏輯 case NO.2: /**NO.2條件說明*/ 業務邏輯 break; . . . case NO.n: /**NO.n條件說明*/ 業務邏輯 break; default: /**default條件說明*/ 業務邏輯 } return returnTypeVariableName; ##1.return 要和之前的業務邏輯代碼之間和方法結束代碼各留有一個空白行 } ##1.調用類中靜態方法須要使用ClassName.doMethodName1()，不能使用variableClassName.doMethodName1() /** *方法說明 * *@author authorName updateDate *@param object object's explanation *@return returnType *@throws RuntimeException Exception * */ protected returnType doMethodName2(Object object) throws RuntimeException, Exception{ 規則見上一個靜態方法 } /** *方法說明 * *@author authorName updateDate *@param object object's explanation *@param variable variable's explanation *@return returnType * */ private returnType doMethodName3(Object object, int variable){ 規則見上上個靜態方法 } ##1.方法的按可見性由大到小排序，同樣可見性能夠按名稱排序或者按參數個數排序，排序能夠靈活 } class ClassName extends FatherClassName implements InterfaceName1, InterfaceName2{ 規則見上個public類 } . . . ##################################################################### 1.一個文件里僅僅有一個為public的類 2.每行的代碼長度不要超過70列 3.注意代碼縮進 4.變量名稱應短小有意義，第一個單詞應為名詞且首字母小寫，后面組合單詞部分首字母大寫 5.變量名稱除循環使用的控制循環的變量外，嚴禁使用a,b,c,i,j,k等單個字母 6.全部暫時變量開頭應以temp開頭，并在代碼審查的時候盡量去除掉 7.暫時的任務用//TODO 凝視，而且保證最后提交代碼沒有能夠完畢的TODO部分還保留TODOkeyword 8.當booleanEquation有多個推斷條件時，注意使用括號加以區分 9.可見性的范圍一定要注意。不須要對類外部發布的就設置為對外不可見 10.假設類繼承Serializable接口。盡量使用private static final long serialVersionUID = 1L;這個默認值 11.get和set的類的私有變量類型要使用基本類型的封裝類，如Integer, Long等 #####################################################################

轉載于:https://www.cnblogs.com/jzdwajue/p/6737957.html

總結

以上是生活随笔為你收集整理的规定自己的Java编码规范的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。