Android 代码编写习惯

原创 2015年11月18日 15:57:16

自学Android途中,看到很多关于代码格式与规范的问题,虽然自己的技术还很渣,但是养成一个好的代码编写习惯是很重要的。

这里主要是本人的一些编码习惯总结,想到什么再添上~

项目名的命名习惯:

给自己的项目统一下前缀(类别+序号),看起来舒服一点,以后也好找
对比   
 

XML控件-ID的命名习惯:

如果活动少的话还行,多的话,这个TextView,那个Button...傻傻分不清
我是.xml 文件的缩写+"_"+控件缩写+表示的内容
比如activity_main.xml 下的Button (发送按钮)id="@+id/am_btnSend"



变量的命名习惯:

变量的命名通常以简明达意为主,最好能表达清楚它是什么、干什么的、是实例变量还是局部变量

  • 实例变量,可以在类前加上当前类的首字母小写表示:
    class MyAdapter{
    private Context mContext;
    private Cursor mCursor;
    }
  • 局部变量,可以用小写的类名表示:
    public MyAdapter(Context context,Cursor cursor){
            mContext = context;
            mCursor = cursor;
        }
  • 控件,可用组件名缩写+控件内容表示:
    TextView tvContent= (TextView) layout.findViewById(R.id.list_content);
    TextView tvTime= (TextView) layout.findViewById(R.id.list_time);
    ImageView ivImg= (ImageView) layout.findViewById(R.id.list_img);
    ImageView ivVideo= (ImageView) layout.findViewById(R.id.list_video);


注释习惯:

类的注释:
说明:在Android Studio中,创建新的类文件时,AS会自动为我们生成注释模板,为了能让注释的内容更细致我们可以自己去定义它。
位置:打开Settings(设置)-->Editor-->File and Code Templates-->选中Includes(标签)下面的File Header
格式可以自己定义


这样无论在哪调用类,鼠标移上去就知道它的功能了



下面还有很多可以添加的内容


方法的注释:
我们要养成多写方法的好习惯,不要全部写在一起;当然方法多了,注释也是必不可少的;
位置:打开Settings(设置)-->Editor-->Live Templates

1.点击右边的“+”号;选择第二个 2.Template Group;定义注释组名如:“test_MethodCustom”
2.选中刚创建的注释组(“test_MethodCustom”),再点“+”号,这次选第一个:Live Templates
3.首先:Abbreviation(缩写): 这个随自己喜好,在方法上面敲出缩写,就会自动添加注释模板;
   其次:Template text:和类的注释模板类似,我这就写个时间和功能了;


 最后:点击Edit variables,给添加的变量加上方法,返回确认OK就可以了;



效果和类的注释相似


----------------------------------------------------------------------------------------2016/1/22--------------------------------------------------------------------------------
其实方法的注释,在方法上 打 /** ,系统会自动生成带有说明、参数和返回值的注释,所以我还是把mt 对应的注释内容改为 /**了。。。






版权声明:本文为博主原创文章,未经博主允许不得转载。

相关文章推荐

(写笔记习惯)关于从eclipse导入android studio 中,代码乱码的情况

(写笔记习惯)关于从eclipse导入android studio 中,代码乱码的情况在代码中直接设置GBK编码即可。但是问题来了,运行在APP端会乱码,这关键到android OS 默认编码是UTF...
  • a136558
  • a136558
  • 2015年12月01日 23:59
  • 359

C#代码编写规范及良好习惯

  • 2009年04月17日 22:50
  • 333KB
  • 下载

提高php程序运行效率的50个代码编写习惯

一定要养成良好的编程习惯,这样可以起到事半功倍的效果!比如:在php程序中,用单引号代替双引号来包含字符串,这样做会更快一些。因为php会在两个双引号包围的字符串中搜寻变量,单引号则不会。注意:只有e...

Android 优化代码代码写作习惯代码规整

今天我想说说代码习惯: 刚开始学Android时相信很多新手都会有一个疑问,我们作为菜鸟除了技术上的不足到底哪点比不上大神呢?相信问这个问题的新手,肯定是一个不服输的人(不能叫愤青吧,我认 为愤青貌似...

jdk8之后代码习惯汇总

  • 2017年11月06日 21:34
  • 40KB
  • 下载

结构代码习惯PDF.rar

  • 2011年10月21日 12:30
  • 693KB
  • 下载

Linux下undefined reference to ‘pthread_create’问题解决接触了Linux系统编程中的线程编程模块,可gcc sample.c(习惯把书上的sample代码写

接触了Linux系统编程中的线程编程模块,可gcc sample.c(习惯把书上的sample代码写进sample.c文件中)出现“undefined reference to ‘pthread_...

PANDAS和SAS的代码使用习惯比较

作为习惯,一般导入下面包命名 In [1]: import pandas as pd In [2]: import numpy as np 数据框架对象df可以通过df.head()显示前面...
  • AnyJack
  • AnyJack
  • 2016年07月31日 23:03
  • 1534

良好的代码习惯(四)

【《代码整洁之道》精读与演绎】之四 优秀代码的格式准则 2016-08-21 21:00 3114人阅读 评论(8) 收藏 举报 本文章已收录于: 分类: 【读书笔记】(2) ...
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:Android 代码编写习惯
举报原因:
原因补充:

(最多只允许输入30个字)