加入收藏 | 设为首页 | 会员中心 | 我要投稿 揭阳站长网 (https://www.0663zz.cn/)- 机器学习、行业智能、决策智能、云计算、AI应用!
当前位置: 首页 > 站长资讯 > 评论 > 正文

教你如何写出Android规范文档

发布时间:2021-03-13 13:03:59 所属栏目:评论 来源:互联网
导读:系统设计 强制: 不允许出现两段相同的逻辑块, 必须抽出为公共方法, 差异性使用参数控制, 避免修改时多处修改导致遗漏; 不允许出现两段相同的处于同一逻辑组的复杂布局, 必须抽为单独的include/merge; 不允许父类中出现子类具体方法, 如果需要的话可以父类定

系统设计

强制:

  • 不允许出现两段相同的逻辑块, 必须抽出为公共方法, 差异性使用参数控制, 避免修改时多处修改导致遗漏;
  • 不允许出现两段相同的处于同一逻辑组的复杂布局, 必须抽为单独的include/merge;
  • 不允许父类中出现子类具体方法, 如果需要的话可以父类定义抽象方法, 交由子类实现;
  • 不允许Activity内多Fragment之间的直接沟通, 必须通过Activity中转。

推荐:

  • 推荐使用MVP或者MVVM架构;
  • 推荐使用Kotlin语言;
  • 采用模块分类方式替代文件类别方式, 方便快速查找模块相关内容, 例: LoginActivity/LoginPreenter/LoginHttpRequest/LoginBean/LoginAdapter等所属同一登录模块的文件放入一个文件夹, 而不是所有activity放入一个文件夹, 所有adapter放入一个文件夹。

命名方式

强制:

  • 不允许出现中文命名方式;
  • java/kotlin文件使用大驼峰方式, 例: LoginActivity.kt, NewsAdapter.kt, NewsBean.java;
  • layout/drawable/anim/style等resource文件使用小写+下划线的方式, 例: login_activity.xml, login_logo.png;
  • 类定义使用大驼峰方式, 例: class LoginPresenter {}, class NewsBean {};
  • 对象使用小驼峰方式, 例: LoginPresenter loginPresenter, NewsBean newsBean;
  • 静态常量使用全大写+下划线的方式, 例: public static final boolean IS_RELESAE = true;
  • Kotlin使用的布局中的控件id必须使用小驼峰方式, 例: android:id="@+id/tvLogin"。

推荐:

  • 文件/资源命名时采用 模块+类型 的方式, 以便迅速查找相关内容, 例如登录页面: LoginActivity.kt, login_activity.xml, login_logo.png, 网络错误, #f3f3f3
  • java使用的布局中的id名建议使用小驼峰方式, 并且使用控件类型缩写开头, 例: android:id="@+id/tvLogin", 附录常用控件缩写:

(编辑:揭阳站长网)

【声明】本站内容均来自网络,其相关言论仅代表作者个人观点,不代表本站立场。若无意侵犯到您的权利,请及时与联系站长删除相关内容!

    推荐文章
      热点阅读