Java 編程命名規範
參考:https://www.cnblogs.com/maowang1991/p/3162366.html
一、命名規範
1、 項目名全部小寫
2、 包名全部小寫
3、 類名首字母大寫,如果類名由多個單詞組成,每個單詞的首字母都要大寫。
如:public class MyFirstClass{}
4、 變量名、方法名首字母小寫,如果名稱由多個單詞組成,每個單詞的首字母都要大寫。
如:int index=0;
public void toString(){}
5、 常量名全部大寫
如:public static final String GAME_COLOR=”RED”;
6、所有命名規則必須遵循以下規則:
1)、名稱只能由字母、數字、下劃線、$符號組成
2)、不能以數字開頭
3)、名稱不能使用JAVA中的關鍵字。
4)、堅決不允許出現中文及拼音命名。
二、註釋規範
1、 類註釋
在每個類前面必須加上類註釋,註釋模板如下:
/**
* Copyright (C), 2006-2010, ChengDu Lovo info. Co., Ltd.
* FileName: Test.java
* 類的詳細說明
*
* @author 類創建者姓名
* @Date 創建日期
* @version 1.00
*/
2、 屬性註釋
在每個屬性前面必須加上屬性註釋,註釋模板如下:
/** 提示信息 */
private String strMsg = null;
3、 方法註釋
在每個方法前面必須加上方法註釋,註釋模板如下:
/**
* 類方法的詳細使用說明
*
* @param 參數1 參數1的使用說明
* @return 返回結果的說明
* @throws 異常類型.錯誤代碼 註明從此類方法中拋出異常的說明
*/
4、 構造方法註釋
在每個構造方法前面必須加上註釋,註釋模板如下:
/**
* 構造方法的詳細使用說明
*
* @param 參數1 參數1的使用說明
* @throws 異常類型.錯誤代碼 註明從此類方法中拋出異常的說明
*/
5、 方法內部註釋
在方法內部使用單行或者多行註釋,該註釋根據實際情況添加。
如://背景顏色
Color bgColor = Color.RED
Java 編程命名規範