一文帶你瞭解Java的命名規範!

千鋒武漢發表於2021-05-08

 在程式設計的世界裡,每種語言都有自己的一些規範。下面,小千帶你瞭解Java命名規範。對於程式設計師來說,如果想學好一門語言,如果想要自己寫出來的程式碼能被他人輕易地讀懂,深入的學習命名規範是非常必要的一件事情。在這裡,小千總結了一下Java的命名規範。

1

  一、Java命名規範:

  1、 專案名稱全部小寫;

  2、 包名全部小寫;

  3、 類名首字母大寫,如果類名由多個字母組成,每個首字母都需要大寫;

  如:public class MyFirstClass{}

2

   4、 變數名和方法名首字母小寫,如果由多個單片語成,其後的每個首字母都需要大寫;

  如:int index=0;

  public void toString(){}

3

  5、 常量名稱全部大寫;

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

4

   6、 所有命名規則必須遵循以下原則;

  (1) 名稱只能有字母、數字、下劃線和$符號組成;

  (2) 不能以數字開頭;

  (3) 名稱堅決不能用Java中的關鍵字;

  (4) 堅決不允許出現中文或拼音命名;

  二、Java註釋規範:

  1、 類註釋

  在每個類前面必須加類註釋,註釋模板如下:

  /**

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

  * FileName: Test.java

  * 類的詳細說明

  *

  * @author 類建立者姓名

  * @Date 建立日期

  * @version 1.00

  */

  即:

5

  設定如下:

6

 

7

  2、 屬性註釋

  在每個屬性前面加上屬性註釋,註釋模板如下:

  /** 提示資訊 */

  private String strMsg = null;

  即:

8

  3、 方法註釋

  在每個方法前面必須加上方法註釋。

  /**

  * 類方法的詳細使用說明

  *

  * @param 引數1 引數1的使用說明

  * @return 返回結果的說明

  * @throws 異常型別.錯誤程式碼 註明從此類方法中丟擲異常的說明

  */

  即:

9


來自 “ ITPUB部落格 ” ,連結:http://blog.itpub.net/31548651/viewspace-2771304/,如需轉載,請註明出處,否則將追究法律責任。

相關文章