標籤:android編碼規範
1.包命名
一個唯一的包名總是全部小寫,構造為頂級網域名稱com/edu/net+機構部門縮小+項目所寫+模組名
例如com.tghz.gameimsdk.activity
2.類命名
類名採用駝峰式命名,大小寫混合,每個單詞的首字母大寫,使用完整單詞,避免縮寫詞(除非該縮寫詞被廣泛的使用,如URL,HTML)。
類名的每個單詞為名詞,避免出現無意義的單詞,如class BookReadPlanActivity 改為class BookReadPlan,可以採用底線來區分。
3.介面名
介面一般要使用able,ible,er等尾碼,如class Raster ,class ImageSprite。
4.方法的命名
方法名是一個動詞,採用大小寫混寫的方式,第一個的單詞的首字母小寫。
例如 public void run(); public void getName();
類中常用方法的命名:
(1). 類的擷取方法,一般具有返回值,則要求在被訪問的欄位名前加上get,如getFirstName(),getLastName()。
一般來說,get首碼方法返回的是一個值,而find首碼方法返回的是列表值。
(2).類的設定方法,一般傳回型別為void,被訪問的欄位名前面加上首碼set。例如:setFirstName(),setLastName()。
(3).類的布爾型的判斷方法一般要求方法名使用單詞is或has首碼,如isPersistent(),isString()。或者使用具有邏輯意義的單詞,如equal或equals。
(4).類的一般方法盡量採用完整的英文描述說明成員方法功能,第一個單詞儘可能採用動詞,首字母小寫,如openFile(),addCount()。
(5).構造方法應該用遞增方式寫,參數多的寫到後面。
(6).toString()方法,一般來說每個類都應該定義toString方法。
5.變數命名
採用駝峰式命名,第一個單詞的首字母要小寫,變數名不應以底線或貨幣符號來開頭,盡量避免單個字元的使用,除非是一次性的臨時變數,
臨時變數通常被取名i,j,k,m,n,一般用於整型,c,d,e她們用於字元型。
注意:不要在私人變數前添加m字樣。
6.常量命名
類常量的聲明,應該全部大寫,單詞間用底線隔開。
例如:static final int MIN_WIDTH=4;
7.layout命名
layout.xml的命名必須全部小寫,單詞間使用底線分隔,構造形式:模組名_功能名稱。
例如某個Activity的布局檔案:activity_home.xml
某個View的布局檔案:view_emot_panel.xml
8.id命名
全部小寫,單詞間底線隔開,並且要求能夠通過id直接理解當前組件要實現的功能。
如某個TextView @+id/book_name_show,某個EditText @+id/book_name_edit。
9.資源命名
layout中的全部資源(drawable,style)單詞全部小寫,單詞間以底線分割,構造形式:模組名_用途。
如果為公用資源,如分割線,使用其功能來命名。
如 menu_icon_nevigate.png,
某分割線line.png改為separator.png
注釋
Java中有兩類注釋:實現注釋和文檔注釋。實現注釋是使用/*...*/和//界定的注釋。
文檔注釋有/**...*/界定。文檔注釋可以通過javadoc工具來產生HTML檔案。
(1).檔案注釋(實現注釋)
所有的源檔案都應該在開頭有一個注釋,其中列出類名,版本資訊,日期和著作權聲明。
如下:
<span style="font-size:14px;"> /* * 檔案名稱 * 包含類名列表 * 版本資訊,版本號碼 * 建立日期 * 著作權聲明 */</span>
(2).類注釋(文檔注釋)
每一個類都要包含如下格式的注釋,以說明當前類的功能等。
<span style="font-size:14px;"> /** * 類名 * @author 作者 * 實現的主要功能 * 建立日期 * 修改者,修改日期,修改內容 */</span>
(3).方法注釋(文檔注釋)
要包含:當前方法的用途,當前方法參數的含義,當前方法返回值的內容和拋出異常的列表。
<span style="font-size:14px;"> /** * 方法的一句話概述 * 方法詳述 * @param 說明參數的含義 * @return 說明傳回值含義 * @throws IOException 說明此發生異常的條件 * @throws NullPointerException 說明發生此異常的條件 */</span>
(4).類成員變數
和常量注釋(文檔注釋)
使用javadoc形式的注釋,以說明當前變數或常量的含義。
<span style="font-size:14px;"> /** * 變數的含義 */ </span>
注意:不要在方法內部使用文檔注釋,使用多方//或/*...*/
Android 編碼規範