Java 項目命名規(guī)范

一墩剖、命名規(guī)范

  1. 項目名全部小寫
  2. 包名全部小寫
  3. 類名首字母大寫挑胸,如果類名由多個單詞組成痒筒,每個單詞的首字母都要大寫。
public class MyFirstClass{}
  1. 變量名嗜暴、方法名首字母小寫凸克,如果名稱由多個單詞組成闷沥,每個單詞的首字母都要大寫。
int index=0;
public void toString(){}
  1. 常量名全部大寫
public static final String GAME_COLOR=”RED”;
  1. 所有命名規(guī)則必須遵循以下規(guī)則:
  • 名稱只能由字母咐容、數(shù)字舆逃、下劃線、$符號組成
  • 不能以數(shù)字開頭
  • 名稱不能使用JAVA中的關(guān)鍵字戳粒。
  • 堅決不允許出現(xiàn)中文及拼音命名路狮。

二、注釋規(guī)范

  1. 類注釋
    在每個類前面必須加上類注釋蔚约,注釋模板如下:
/**
  * Copyright (C), 2006-2010, ChengDu Lovo info. Co., Ltd.
  * FileName: Test.java
  * 類的詳細(xì)說明
  *
  * @author 類創(chuàng)建者姓名
  * @Date    創(chuàng)建日期
  * @version 1.00
*/
  1. 屬性注釋
    在每個屬性前面必須加上屬性注釋奄妨,注釋模板如下:
/** 提示信息 */
private String strMsg = null;
  1. 方法注釋
    在每個方法前面必須加上方法注釋,注釋模板如下:
/**
  * 類方法的詳細(xì)使用說明
  *
  * @param 參數(shù)1 參數(shù)1的使用說明
  * @return 返回結(jié)果的說明
  * @throws 異常類型.錯誤代碼 注明從此類方法中拋出異常的說明
*/
  1. 構(gòu)造方法注釋
    在每個構(gòu)造方法前面必須加上注釋苹祟,注釋模板如下:
/**
  * 構(gòu)造方法的詳細(xì)使用說明
  *
  * @param 參數(shù)1 參數(shù)1的使用說明
  * @throws 異常類型.錯誤代碼 注明從此類方法中拋出異常的說明
*/
  1. 方法內(nèi)部注釋
    在方法內(nèi)部使用單行或者多行注釋砸抛,該注釋根據(jù)實(shí)際情況添加评雌。
//背景顏色
Color bgColor = Color.RED
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市直焙,隨后出現(xiàn)的幾起案子景东,更是在濱河造成了極大的恐慌,老刑警劉巖奔誓,帶你破解...
    沈念sama閱讀 216,651評論 6 501
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件斤吐,死亡現(xiàn)場離奇詭異,居然都是意外死亡厨喂,警方通過查閱死者的電腦和手機(jī)和措,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,468評論 3 392
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來蜕煌,“玉大人臼婆,你說我怎么就攤上這事』仙埽” “怎么了颁褂?”我有些...
    開封第一講書人閱讀 162,931評論 0 353
  • 文/不壞的土叔 我叫張陵,是天一觀的道長傀广。 經(jīng)常有香客問我颁独,道長,這世上最難降的妖魔是什么伪冰? 我笑而不...
    開封第一講書人閱讀 58,218評論 1 292
  • 正文 為了忘掉前任誓酒,我火速辦了婚禮,結(jié)果婚禮上贮聂,老公的妹妹穿的比我還像新娘靠柑。我一直安慰自己,他們只是感情好吓懈,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,234評論 6 388
  • 文/花漫 我一把揭開白布歼冰。 她就那樣靜靜地躺著,像睡著了一般耻警。 火紅的嫁衣襯著肌膚如雪隔嫡。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 51,198評論 1 299
  • 那天甘穿,我揣著相機(jī)與錄音腮恩,去河邊找鬼。 笑死温兼,一個胖子當(dāng)著我的面吹牛秸滴,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播募判,決...
    沈念sama閱讀 40,084評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼荡含,長吁一口氣:“原來是場噩夢啊……” “哼咒唆!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起内颗,我...
    開封第一講書人閱讀 38,926評論 0 274
  • 序言:老撾萬榮一對情侶失蹤钧排,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后均澳,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體恨溜,經(jīng)...
    沈念sama閱讀 45,341評論 1 311
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,563評論 2 333
  • 正文 我和宋清朗相戀三年找前,在試婚紗的時候發(fā)現(xiàn)自己被綠了糟袁。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 39,731評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡躺盛,死狀恐怖项戴,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情槽惫,我是刑警寧澤周叮,帶...
    沈念sama閱讀 35,430評論 5 343
  • 正文 年R本政府宣布,位于F島的核電站界斜,受9級特大地震影響仿耽,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜各薇,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,036評論 3 326
  • 文/蒙蒙 一项贺、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧峭判,春花似錦开缎、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,676評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至治宣,卻和暖如春急侥,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背侮邀。 一陣腳步聲響...
    開封第一講書人閱讀 32,829評論 1 269
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留贝润,地道東北人绊茧。 一個月前我還...
    沈念sama閱讀 47,743評論 2 368
  • 正文 我出身青樓,卻偏偏與公主長得像打掘,于是被迫代替她去往敵國和親华畏。 傳聞我的和親對象是個殘疾皇子鹏秋,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,629評論 2 354

推薦閱讀更多精彩內(nèi)容