一文带你了解Java的命名规范!
在編程的世界里,每種語言都有自己的一些規(guī)范。下面,小千帶你了解Java命名規(guī)范。對于程序員來說,如果想學(xué)好一門語言,如果想要自己寫出來的代碼能被他人輕易地讀懂,深入的學(xué)習(xí)命名規(guī)范是非常必要的一件事情。在這里,小千總結(jié)了一下Java的命名規(guī)范。
一、Java命名規(guī)范:
1、 項目名稱全部小寫;
2、 包名全部小寫;
3、 類名首字母大寫,如果類名由多個字母組成,每個首字母都需要大寫;
如:public class MyFirstClass{}
4、 變量名和方法名首字母小寫,如果由多個單詞組成,其后的每個首字母都需要大寫;
如:int index=0;
public void toString(){}
5、 常量名稱全部大寫;
如:public static final String GAME_COLOR=”RED”;
6、 所有命名規(guī)則必須遵循以下原則;
(1) 名稱只能有字母、數(shù)字、下劃線和$符號組成;
(2) 不能以數(shù)字開頭;
(3) 名稱堅決不能用Java中的關(guān)鍵字;
(4) 堅決不允許出現(xiàn)中文或拼音命名;
二、Java注釋規(guī)范:
1、 類注釋
在每個類前面必須加類注釋,注釋模板如下:
/**
* Copyright ?, 2006-2010, ChengDu Lovo info. Co., Ltd.
* FileName: Test.java
* 類的詳細(xì)說明
*
* @author 類創(chuàng)建者姓名
* @Date 創(chuàng)建日期
* @version 1.00
*/
即:
設(shè)置如下:
2、 屬性注釋
在每個屬性前面加上屬性注釋,注釋模板如下:
/** 提示信息 */
private String strMsg = null;
即:
3、 方法注釋
在每個方法前面必須加上方法注釋。
/**
* 類方法的詳細(xì)使用說明
*
* @param 參數(shù)1 參數(shù)1的使用說明
* @return 返回結(jié)果的說明
* @throws 異常類型.錯誤代碼 注明從此類方法中拋出異常的說明
*/
即:
本文來自千鋒教育,轉(zhuǎn)載請注明出處。
總結(jié)
以上是生活随笔為你收集整理的一文带你了解Java的命名规范!的全部內(nèi)容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: 五分钟了解一致性hash算法!
- 下一篇: 这6个高效的Java库,你知道吗?