Android_項目編碼規(guī)范.doc

Android項目編碼規(guī)范1. 介紹為什么要有編碼規(guī)范編碼規(guī)范對于程序員而言尤為重要，有以下幾個原因：- 一個軟件的生命周期中，80%的花費在于維護- 幾乎沒有任何一個軟件，在其整個生命周期中，均由最初的開發(fā)人員來維護- 編碼規(guī)范可以改善軟件的可讀性，可以讓程序員盡快而徹底地理解新的代碼- 如果你將源碼作為產(chǎn)品發(fā)布，就需要確任它是否被很好的打包并且清晰無誤，一如你已構(gòu)建的其它任何產(chǎn)品 為了執(zhí)行規(guī)范，每個軟件開發(fā)人員必須一致遵守編碼規(guī)范。2. 命名規(guī)則由于Android 開發(fā)應用中、各個應用的包名一定要區(qū)分、否則后安裝的應用程序會覆蓋先前安裝的應用，所以要求各個應用的包名命名需特別關注。包(Packages)：所有項目包名以net.sunniwell 開頭。后面是程序所在項目的英文名稱（小寫），再下為子系統(tǒng)的名稱，每個子系統(tǒng)內(nèi)按照類別區(qū)分。如：項目 SWLaunchernet.sunniwell.swlanuchernet.sunniwell.swlanucher.tools其他命名規(guī)則參照“Java代碼開發(fā)規(guī)范”3. 類變量聲明聲明的變量各個部分出現(xiàn)的先后次序要求如下：類的（靜態(tài)）變量。首先是公共（public）變量，隨后是保護（protected）變量，再后是包級別的變量（沒有訪問修飾符的，默認為friendly），最后是私有（private）變量。實例變量。首先是公共（public）變量，隨后是保護（protected）變量，再后是包級別的變量（沒有訪問修飾符的，默認為friendly），最后是私有（private）變量。private static Object sLock = null; / 靜態(tài)成員變量以s開頭 private int mScreenOff = 0; / 非靜態(tài)成員變量名以m開頭4. 資源文件命名規(guī)范1. res/layout文件夾命名規(guī)范：統(tǒng)一用小寫和下劃線_組合命名，建議xml文件加個前綴以便區(qū)分，如:對話框的xml配置文件:dlg_name.xml;2. res/drawable文件命名規(guī)范：統(tǒng)一用小寫加下劃線“_”組合命名，同上，每個資源文件最好加個前綴以便區(qū)分，如:btn_default.png,btn_pressed.png,btn_focus.xml;5. 注釋類文件開頭所有的類文件開頭、必須要有類的主要作用的簡單說明、類創(chuàng)建日期、作者信息、/* * Classname * Date* author Author */方法注釋主要注釋有如下：1.類該方法作用是什么？2. param 各個參數(shù)說明3.異常處理。throws4.return 方法返回值、代表的意義 （如：數(shù)值，1：成功，0：失?。├纾?* * 類方法注釋 * param param1 數(shù)據(jù)1 * param param2 數(shù)據(jù)2 * return 返回測試值 、意義 */ public String getBossId(int param1, int param2) return bob; 6. 日志日志標記統(tǒng)一定義為靜態(tài)常量類名：例