java命名規(guī)范

一、命名規(guī)范

1、 項(xiàng)目名全部小寫

2、 包名全部小寫

3、 類名首字母大寫,如果類名由多個(gè)單詞組成,每個(gè)單詞的首字母都要大寫。

如:public class MyFirstClass{}

4、 變量名、方法名首字母小寫,如果名稱由多個(gè)單詞組成,每個(gè)單詞的首字母都要大寫。

如:int index=0;

   public void toString(){}

5、 常量名全部大寫

如:public static final String GAME_COLOR=”RED”;

6、所有命名規(guī)則必須遵循以下規(guī)則:

1)、名稱只能由字母、數(shù)字、下劃線、$符號(hào)組成

2)、不能以數(shù)字開頭

3)、名稱不能使用JAVA中的關(guān)鍵字。

4)、堅(jiān)決不允許出現(xiàn)中文及拼音命名。

二、注釋規(guī)范

1、 類注釋

在每個(gè)類前面必須加上類注釋,注釋模板如下:

/**

  • Copyright (C), 2006-2010, ChengDu Lovo info. Co., Ltd.

  • FileName: Test.java

  • 類的詳細(xì)說明

  • @author 類創(chuàng)建者姓名

    • @Date 創(chuàng)建日期
  • @version 1.00

*/

2、 屬性注釋

在每個(gè)屬性前面必須加上屬性注釋,注釋模板如下:

/** 提示信息 */

private String strMsg = null;

3、 方法注釋

在每個(gè)方法前面必須加上方法注釋,注釋模板如下:

/**

  • 類方法的詳細(xì)使用說明

  • @param 參數(shù)1 參數(shù)1的使用說明

  • @return 返回結(jié)果的說明

  • @throws 異常類型.錯(cuò)誤代碼 注明從此類方法中拋出異常的說明

*/

4、 構(gòu)造方法注釋

在每個(gè)構(gòu)造方法前面必須加上注釋,注釋模板如下:

/**

  • 構(gòu)造方法的詳細(xì)使用說明

  • @param 參數(shù)1 參數(shù)1的使用說明

  • @throws 異常類型.錯(cuò)誤代碼 注明從此類方法中拋出異常的說明

*/

5、 方法內(nèi)部注釋

在方法內(nèi)部使用單行或者多行注釋,該注釋根據(jù)實(shí)際情況添加。

如://背景顏色

   Color bgColor = Color.RED

內(nèi)容僅供個(gè)人學(xué)習(xí)、記錄使用,侵刪
![G}_LJ$F47T%GEB4G4APHLJ.png

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡(jiǎn)書系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。

友情鏈接更多精彩內(nèi)容