android 開發規范 (2) - 類

關于java 類所涉及到的開發規范有以下幾個內容:

  • 類命名
  • 類書寫順序

類命名

  • 使用名詞 / 名詞短語,不能使用拼音
  • 抽象類盡量使用 Abstract / Base 前綴
  • 接口使用 I 前綴
  • 使用大駝峰法命名,首字母大寫
  • 盡量避免縮寫,除非該縮寫是眾所周知的, 比如 HTML、URL,如果類名稱中包含單詞縮寫,則單詞縮寫的每個字母均應大寫。
  • 類以功能為基準,添加后綴
描述 例如
Activity 類 Activity 為后綴標識 歡迎頁面類 WelcomeActivity
Adapter 類 Adapter 為后綴標識 新聞詳情適配器 NewsDetailAdapter
解析類 Parser 為后綴標識 首頁解析類 HomePosterParser
工具方法類 Utils 或 Manager 為后綴標識 線程池管理類:ThreadPoolManager
日志工具類 LogUtils(Logger 也可) .......
打印工具類 PrinterUtils ......
數據庫類 以 DBHelper 后綴標識 新聞數據庫:NewsDBHelper
Service 類 以 Service 為后綴標識 時間服務 TimeService
BroadcastReceiver 類 以 Receiver 為后綴標識 推送接收 JPushReceiver
ContentProvider 類 以 Provider 為后綴標識 ShareProvider
自定義的共享基礎類 以 Base 開頭 BaseActivity, BaseFragment

類成員書寫順序

這里沒有唯一性寫法,只是推薦性寫法,當然這樣寫的確是更耐看:

  • 常量
  • 字段
  • 構造函數
  • 公有函數
    公有函數都是要對外展示的, 是外部最關心的方法,所以應該放到最前面
  • 重寫函數和回調 ( 包括生命周期函數,聲明周期函數優先 )
  • 私有函數
  • 內部類或接口
public class MainActivity extends Activity {

    private static final String TAG = MainActivity.class.getSimpleName();

    private String mTitle;
    private TextView mTextViewTitle;

    @Override
    public void onCreate() {
        ...
    }

    public void setTitle(String title) {
        mTitle = title;
    }

    private void setUpView() {
        ...
    }

    static class AnInnerClass {

    }
}
最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。