• Android 编码规范 Android 获取手机信息


    一、命名
    1.包 一个唯一包名的前缀总是全部小写的 ASCII 字母并且是一个顶级域名,通
    常是 com,edu,gov,mil,net,org。包名的后续部分根据不同机构各自内部的命名
    规范而不尽相同。

    例如: com.hymobile.nloc.activities

    2.类  类名是个一名词,大小写字母混合组成,每个单词的首字母大写。

        规约:类名必须使用名词,或名词词组。要求类名简单,不允许出现无意义的单词(如 class XXXActivity)。
        如:class BookMarkAdd  正确
        如:class AddBookReadPlanActivity  错误! 应为 class BookReadPlanAdd

    3.接口 大小写字母混合组成,头字母大写,常以"able"、"ible" "er"结尾。

    interface RasterDelegate;
    interface Runnable;
    interface Accessible;

    4.方法 方法名是一个动词,大小写字母混合组成,第一个单词的首字母小写,其后单词的首字母大写。

    run();
    runFast();
    getBackground();

    类中常用方法的命名:
    1.  类的获取方法(一般具有返回值)一般要求在被访问的字段名前加上 get,如
    getFirstName()。一般来说,get 前缀方法返回的是单个值,find 前缀的方法返回的是列表值。
    2.  类的设置方法(一般返回类型为 void):被访问字段名的前面加上前缀  set,如
    setFirstName(),setLastName().
    3.  类的布尔型的判断方法一般要求方法名使用单词  is 或 has  做前缀,如 isPersistent(),
    isString()。或者使用具有逻辑意义的单词,例如 equal  或 equals。
    4.  类的普通方法一般采用完整的英文描述说明成员方法功能,第一个单词尽可能采用
    动词,首字母小写,如 openFile(),addCount()。
    5.  构造方法应该用递增的方式写。(参数多的写在后面)。
    6.  toString()方法:一般情况下,每个类都应该定义 toString(),其格式为:

    5.变量、成语变量  常量参数 小写,不推荐使用下划线,简短明晰。

    * 非公有,非静态字段命名以m开头。
    * 静态域命名以s开头。
    * 其他字段以小写字母开头。
    * public static final 字段(常量) 全部大写,并用下划线连起来。
    [java] view plaincopy
    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; 
    首席御医www.wo-cn.com/shouxiyuyi

    6.集合、数组 应该从命名中体现其复数的含义,例如加后缀s或前缀some。

    customers;
    postedMessages;
    someCustomers;
    someItems;

    7. layout 命名
    layout xml 的命名必须以 全部单词小写,单词间以下划线分割,并且使用名
    词或名词词组,即使用 模块名_功能名称 来命名。


    8. layout中的id命名 

    以全部单词小写,单词间以下划线分割,并且使用
    名词或名词词组,并且要求能够通过 id 直接理解当前组件要实现的功能命名模式为:view缩写_模块名称_view的逻辑名称
    view的缩写详情如下
    LayoutView: lv
    RelativeView:  rv
    TextView:  tv
    ImageView:  iv
    ImageButton: im
    Button: btn

    9.activity中的view变量命名
    命名模式为:逻辑名称+view缩写
    建议:如果layout文件很复杂,建议将layout分成多个模块,每个模块定义一个moduleViewHolder,其成员变量包含所属view


    10. 资源命名

    规约: layout 中所使用的所有资源(如 drawable,style 等)命名必须以全部单词小写,
    单词间以下划线分割,并且尽可能的使用名词或名词组,即使用 模块名_用途 来命名。
    如果为公共资源,如分割线等,则直接用用途来命名

        10.1) strings.xml中的id命名
          命名模式:activity名称_功能模块名称_逻辑名称/activity名称_逻辑名称/common_逻辑名称
          strings.xml中,使用activity名称注释,将文件内容区分开来
        10.2) drawable中的图片命名
          命名模式:activity名称_逻辑名称/common_逻辑名称
        10.3) styles.xml:将layout中不断重现的style提炼出通用的style通用组件,放到styles.xml中;


    二、注释/JavaDoc
    1.顶部版权声明
    2.包和引入块(每一块以空白行分隔)
    3.类或接口的声明。 在Javadoc注释,描述的类或接口的用途。

    类/接口注释的内容(1项 要求写上)
    类、接口的文档注释包含如下信息:
    1.用途。开发人员使用某个类/接口之前,需要知道采用该类/接口的用途。
    2.如何使用。开发人员需要知道该类/接口应该如何使用,如果必要的话还需要注明不应
    该如何使用。
    3.开发维护的日志。一个有关于该类/接口的维护记录:时间、作者、摘要。

    方法注释的内容(1,5,6,7项 要求写上)
    1.类该方法是做什么的。
    2.该方法如何工作。
    3.代码修改历史纪录。
    4.方法调用代码示范。
    5.必须传入什么样的参数给这个方法。@param
    6.异常处理。@throws
    7.这个方法返回什么。@return

    1.  文件注释
    所有的源文件都应该在开头有一个注释,其中列出类名、版本信息、日期和版权声明。
    如下:
    /*
    * 文件名
    * 包含类名列表
    * 版本信息,版本号
    * 创建日期。
    * 版权声明
    */
    2.  类注释
    每一个类都要包含如下格式的注释,以说明当前类的功能等。
    /**
    * 类名
    * @author 作者 <br/>
    *  实现的主要功能。
    *  创建日期
    *  修改者,修改日期,修改内容。
    */
    3.  方法注释
    每一个方法都要包含 如下格式的注释 包括当前方法的用途,当前方法参数的含义,当
    前方法返回值的内容和抛出异常的列表。
    /**
    *
    * 方法的一句话概述
    * <p>方法详述(简单方法可不必详述)</p>
    * @param s 说明参数含义
    * @return 说明返回值含义
    * @throws IOException 说明发生此异常的条件
    * @throws NullPointerException 说明发生此异常的条件
    */
    4.  类成员变量和常量注释
    成员变量和常量需要使用 java doc 形式的注释,以说明当前变量或常量的含义
    /**
    * XXXX含义
    */
    5.  其他注释
    方法内部的注释 如果需要多行 使用/*„„ */形式,如果为单行是用//„„形式的注
    释。不要再方法内部使用 java doc 形式的注释“/**„„**/”,简单的区分方法是,
    java doc 形式的注释在 eclipse 中为蓝色,普通注释为绿色。
    6.  XML 注释
    规约:如果当前 layout 或资源需要被多处调用,或为公共使用的 layout (若 list_item),
    则需要在 xml 写明注释。要求注释清晰易懂。

    三、规约
    1.  方法
      一个方法尽量不要超过 15 行,如果方法太长,说明当前方法业务逻辑已经非常复杂,
    那么就需要进行方法拆分,保证每个方法只作一件事。
      不要使用  try catch  处理业务逻辑!!!!
    2.  参数和返回值
      一个方法的参数尽可能的不要超过 4 个!
      如果一个方法返回的是一个错误码,请使用异常!!
      尽可能不要使用 null ,  替代为异常  或者使用空变量  如返回  List  则可以使用
    Collections.emptyList()
    3.  神秘的数
    代码中不允许出现单独的数字,字符!如果需要使用数字或字符,则将它们按照含义封装
    为静态常量! (for 语句中除外)
    4.  控制语句
    判断中如有常量,则应将常量置于判断式的右侧。如:
    if ( true == isAdmin())...
    尽量不使用三目条件的嵌套。
    所有 if  语句必须用{}包括起来,即便是只有一句:
    if (true){
    //do something......
    }
    if (true)
    i = 0; //不要使用这种
    对于循环:
    //不推荐方式____________________________________________
    while(index < products.getCount()){
    //每此都会执行一次 getCount()方法,
    //若此方法耗时则会影响执行效率
    //而且可能带来同步问题,若有同步需求,请使用同步块或同步方法
    }
    //推荐方式______________________________________________
    //将操作结构保存在临时变量里,减少方法调用次数
    final int count = products.getCount();
    while(index < count){
    }
    5.  异常的捕捉处理
      通常的思想是只对错误采用异常处理:逻辑和编程错误,设置错误,被破坏的数据,资源
    耗尽,等等。
      通常的法则是系统在正常状态下以及无重载和硬件失效状态下,不应产生任何异常。
      最小化从一个给定的抽象类中导出的异常的个数。对于经常发生的可预计事件不要采用异
    常。不要使用异常实现控制结构。
      若有 finally  子句,则不要在 try  块中直接返回,亦不要在 finally  中直接返回。
    6.  访问控制
    若没有足够理由,不要把实例或类变量声明为公有。通常,实例变量无需显式的设置
    (set)和获取(gotten),通常这作为方法调用的边缘效应 (side effect)而产生。
    一个具有公有实例变量的恰当例子,是类仅作为数据结构,没有行为。亦即,若你要
    使用一个结构(struct)而非一个类(如果 java 支持结构的话),那么把类的实例变量声明为
    公有是合适的。

    1) android获取屏幕的高度和宽度用到WindowManager这个类,两种方法:
     
    1.WindowManager wm = (WindowManager) getContext()
                        .getSystemService(Context.WINDOW_SERVICE);
     
         int width = wm.getDefaultDisplay().getWidth();
         int height = wm.getDefaultDisplay().getHeight();
     
    2、WindowManager wm = this.getWindowManager();
     
         int width = wm.getDefaultDisplay().getWidth();
         int height = wm.getDefaultDisplay().getHeight();
  • 相关阅读:
    这个星期一好像有点无聊
    SQL、LINQ、Lambda三种方式比较
    [C#基础知识]Class和Struct的区别
    C#判断大批量的路径是否存在时,如何缩短判断时间
    批处理 for参数之token详解
    批处理Delims的基本知识
    读取txt文本中每一条路径(一行)并判断,路径不存在的保存在另一txt文本中
    批处理获取一些系统参数
    Cannot read configuration file due to insufficient permissions
    my97datepicker日期选择插件的用法
  • 原文地址:https://www.cnblogs.com/jiangye/p/3337011.html
Copyright © 2020-2023  润新知