Java語言編程規范——命名規范

剛接觸Android的時候,命名都是按照拼音來,所以有的時候想看懂命名的那個控件什么是什么用的,就要讀一遍甚至好幾遍才知道,這樣的話,在代碼的審查和修改過程中就會浪費不少不必要的時間。
如果就是我一個人開發,一個人維護的話還好,可是如果一個項目是團隊分工合作,這樣讓你的同事去看你的代碼就更加吃力了,因為大家之間的編程方式不一樣,所以,在開發過程中,命名規范統一尤為重要,最好是團隊中統一好大家命名方法,這樣對于日后的工作會輕松很多。
在面試的時候,審核一個程序員的編程水平的時候,命名規范也是一大標準,所以,下面我就總結下我從網上別人的經驗和自己的感悟中收集總結的android命名規范,希望對大家有所幫助。
提醒:在命名規范的統一下,再加上注釋,這樣日后維護會高效快捷好多

  • 包名采用域后綴倒置的加上自定義的包名,采用小寫字母。包名使用產品的名稱加上模塊的名稱。
    格式:
    com.ruen.產品名.模塊名稱
    示例:
    體檢報告action類 import com.ruen.health.action.ExamReportAction;
    用戶信息實體類 import com.ruen.health.bean.UserInfo;

  • 類名和接口使用類意義完整的英文描述,每個英文單詞的首字母使用大寫、其余字母使用小寫的大小寫混合法。
    示例:OrderInformation, CustomerList, LogManager, LogConfig

  • 方法名使用類意義完整的英文描述:第一個單詞的字母使用小寫、剩余單詞首字母大寫其余字母小寫的大小寫混合法。
    示例:

private void calculateRate();
public void addNewOrder();
  • 屬性名使用意義完整的英文描述:第一個單詞的字母使用小寫、剩余單詞首字母大寫其余字母小寫的大小寫混合法。屬性名不能與方法名相同。
    示例:
private customerName;
private orderNumber;
private smpSession;
  • 常量名使用全大寫的英文描述,英文單詞之間用下劃線分隔開,并且使用 final static 修飾。
    示例:
public final static int MAX_VALUE = 1000;
public final static String DEFAULT_START_DATE = "2001-12-08";
  • 屬性名可以和公有方法參數相同,不能和局部變量相同,引用靜態成員變量時使用類名引用。
    示例:
public class Person
{
    private String name;
    private static List properties;
       
    public void setName (String val)
    {
        name = val;
    }
        
    public void setProperties (List val)
    {
        Person.properties = val;
    }
}

建議

  • 常用組件類的命名以組件名加上組件類型名結尾。
    示例:
    Action類型的,命名以Action結尾——ExamReportAction
    Application 類型的,命名以App 結尾——MainApp
    Frame 類型的,命名以Frame 結尾——TopoFrame
    Panel 類型的,建議命名以Panel 結尾——CreateCircuitPanel
    Bean 類型的,建議命名以Bean 結尾——DataAccessBean
    EJB 類型的,建議命名以EJB 結尾——DBProxyEJB
    Applet 類型的,建議命名以Applet 結尾——PictureShowApplet

  • 如果函數名超過15 個字母,可采用以去掉元音字母的方法或者以行業內約定俗成的縮寫方式縮寫函數名。
    示例:getCustomerInformation() 改為 getCustomerInfo()

  • 準確地確定成員函數的存取控制符號,不是必須使用 public 屬性的,請使用 protected,不是必須使用 protected, 請使用 private。
    示例:protected void setUserName(), private void calculateRate()

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 228,936評論 6 535
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,744評論 3 421
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 176,879評論 0 381
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,181評論 1 315
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,935評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,325評論 1 324
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,384評論 3 443
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,534評論 0 289
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 49,084評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,892評論 3 356
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,067評論 1 371
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,623評論 5 362
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,322評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,735評論 0 27
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,990評論 1 289
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,800評論 3 395
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 48,084評論 2 375

推薦閱讀更多精彩內容