Android 編程規范

前言

通過建立代碼編寫規范,形成Android編碼約定,提高程序的可靠性、可讀性、可修改性、可維護性、一致性,保證程序代碼的質量,繼承軟件開發成果,充分利用資源。提高程序的可繼承性,使開發人員之間的工作成果可以共享。

軟件編碼要遵循以下原則:

  1. 遵循開發流程,在產品和設計的指導下進行代碼編寫。
  2. 代碼的編寫以實現設計的功能和性能為目標,要求正確完成設計要求的功能,達到設計的性能。
  3. 程序具有良好的程序結構,提高程序的封裝性好,減低程序的耦合程度。
  4. 程序可讀性強,易于理解;方便調試和測試,可測試性好。
  5. 易于使用和維護;良好的修改性、擴充性;可重用性強/移植性好。
  6. 占用資源少,以低代價完成任務。
  7. 在不降低程序的可讀性的情況下,盡量提高代碼的執行效率。

一. 命名規范

不要使用漢語拼音簡寫。用準確的英文

  • 包名
    采用反域名命名規則,<font color = "#ff0000">全部使用小寫字母。</font>一級包名為com,二級包名為xxx(可以是公司域名或者個人命名),三級包名根據應用進行命名,四級包名為模塊名或層級名。
  • 類名&接口名
    采用<font color = "#ff0000">大駝峰</font>命名法,盡量避免縮寫,除非該縮寫是眾所周知的,比如HTML,URL,如果類名稱包含單詞縮寫,則單詞縮寫的每個字母均應大寫。
  • 方法名
    動詞或動名詞,采用<font color = "#ff0000">小駝峰</font>命名法,eg:onCreate(),run();
  • (常量) static final字段
    字母全部大寫,單詞間以下劃線分割
  • 全局/全局變量名
    有兩套標準 java(xXXXX) google(mXXXX).我們采用java的標準,<font color = "#ff0000">小駝峰</font>命名法
  • 布局文件名
    contentview命名 功能模塊.xml.
    adapter的子布局:功能模塊_item.xml
    ...
  • 資源文件名
    除通用的資源外,保持和功能模塊一致,自定義的shape等以*.shape.xml
  • 布局文件中view的id名。控件簡寫變量名,textview tv button bt_(或者btn_) LinearLayout ll_ 等。舉例如下:
 <TextView
     android:id="@+id/tv_handed"
     android:layout_width="wrap_content"
     android:layout_height="wrap_content" />

二. 代碼規范

  1. 統一 code style

    采用androidstudio默認即可,檢查下不同系統下是否一致
  2. 編碼方式 "UTF-8"
  3. 使用TODO注釋
對那些臨時性的、短期的、夠棒但不完美的代碼,請使用TODO注釋。
TODO注釋應該包含全部大寫的TODO,后跟一個冒號:
// TODO: Remove this code after the UrlTable2 has been checked in.
和
// TODO: Change this to use a flag instead of a constant.
如果TODO注釋是“將來要做某事”的格式,則請確保包含一個很明確的日期(“在2005年11月會修正”),或是一個很明確的事件(“在所有代碼整合人員理解了V7協議之后刪除本段代碼”)。
  1. 先寫注釋再寫代碼

三. 布局規范

  1. 單位使用規范
    控件長寬采用dp作為統一的衡量單位,字體使用sp作為統一衡量單位。
  2. 切圖命名規范
    具體命名規范,請看《Android切圖規范及命名規則》文檔。
  3. 資源文件夾res下的規范
    在res資源目錄下,應該至少包含下面的目錄結構
    其中,各個版本的drawable中存放的內容如下
    ? drawable 存放使用xml文件實現的各種selector按下效果
    ? drawable-hdpi 存放480800,480854像素的圖片
    ? drawable-ldpi 存放240320像素的圖片,現在基本廢棄
    ? drawable-mdpi 存放320
    480像素的圖片,現在基本廢棄
    ? drawable-xhdpi 存放720*1280像素及以上的圖片
    ? drawable-xxhdpi 暫時只放144px的圖標

四. 參考

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

推薦閱讀更多精彩內容

  • Android 自定義View的各種姿勢1 Activity的顯示之ViewRootImpl詳解 Activity...
    passiontim閱讀 172,603評論 25 707
  • 命名規范 1. 基本原則 (1) 代碼風格與android源碼保持一致(2) 命名要清晰明了、有明確含義(3) ...
    Brian512閱讀 599評論 0 5
  • 參考資料:我總結的Android編程規范 1. 命名規則 1.1 類名,接口名: 以大寫開頭,如果一個類的類名由多...
    Coder_Y閱讀 2,813評論 12 60
  • 架構&分包 -- 原則 包名應讓人一目知意:英文命名描述其功能。 分包層次應盡可能的低,減短包名長度。 Model...
    zhazhaxin閱讀 1,774評論 3 48
  • 綜合練習前面三天所學的一丟丟內容img、href、table、frameset,加以鞏固。框架html: 頂部按鈕...
    zhanglizzy閱讀 667評論 1 0