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 {

    }
}
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
【社区内容提示】社区部分内容疑似由AI辅助生成,浏览时请结合常识与多方信息审慎甄别。
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

友情链接更多精彩内容