Android代码规范+小技巧

最新推荐文章于 2022-06-20 15:42:57 发布

莫大先生

最新推荐文章于 2022-06-20 15:42:57 发布

阅读量297

点赞数

分类专栏： Android Java 文章标签： android 规范

本文链接：https://blog.csdn.net/zxb136475688/article/details/50558114

版权

Android 同时被 2 个专栏收录

10 篇文章 0 订阅

订阅专栏

Java

2 篇文章 0 订阅

订阅专栏

配置篇

layout的xml 命名：以xml类型+”_”开头

example：activity_Login.xml 
            fragment_home.xml    
            item_adapter_order.xml

在xml使用xmlns:tools=http://schemas.android.com/tools ，方便调试，开发

除了text之外，还可以使用visiable等属性
xml控件规范
android:id 明显应该在layout文件中第一行
android:style 放在最后一行
单位
文字大小的单位应该统一用sp，其他元素用dp。因为这两个单位是与设备分辨率无关的，能够解决在不同分辨率设备上显示效果不同的问题。
如果设置layout_weight=1 那么你的layout_width或layout_height 就不要设置成“match_parent”,设置成0dp以便在测量时做出更好的优化
xml的根目录为时，可以用代替，因为activity的父元素就是FrameLayout。当Inflate以开头的布局文件时，必须指定一个父ViewGroup，并且必须设定attachToRoot为true（参看inflate(int,android.view.ViewGroup, Boolean)方法）

代码篇

不要将Context 变量设置为static
在activity中写内部类，一定要把内部类设置为static
保存sharedPreference时，建议用apply()代替commit()(不考虑线程安全的情况下);另外apply没有返回值，而commit返回boolean表明修改是否提交成功;

遵守字段命名惯例:
非public的、非static的字段名称以m开头。
static字段名称以s开头。
其它字段以小写字母开头。
public static final字段（常量）全部字母大写并用下划线分隔。

//example
public class MyClass {
    public static final int SOME_CONSTANT = 42;
    public int publicField;
    private static MyClass sSingleton;
    int mPackagePrivate;
    private int mPrivate;
    protected int mProtected;
}

不要在底层的方法中处理异常，应该向方法的调用者抛出异常。

补充

命名规则

常量：MIN_WIDTH
全局成员变量：private String mMyName;
静态成员变量：static String sMyName;
方法入参变量：pMyName;
私有变量：camel命名法
循环中的变量：缩写字母，无意义字母
控件ID的命名规范：btn_login
类命名：WelcomeActivity
方法命名：动词或动名词，initXX()，isXX()，getXX()，processXX()，displayXX()，saveXX()，resetXX()，clearXX()，removeXXX() ，drawXXX()
资源文件命名：btn_XX

注释的规范：

文件注释：

  /*
   * 文件名 
   * 包含类名列表
   * 版本信息，版本号
   * 创建日期。
   * 版权声明
   */

类注释：

/**
 * 类名
 * @author：作者 
 * @description：实现的主要功能。
 * @date：创建日期
 * 修改者，修改日期，修改内容。
 */

方法注释：

/**
 * 
 * 方法的一句话概述
 * <p>方法详述（简单方法可不必详述）</p>
 * @param s 说明参数含义
 * @return 说明返回值含义
 * @throws IOException 说明发生此异常的条件
 * @throws NullPointerException 说明发生此异常的条件
 */