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 对应的注释内容改为 /**了。。。






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

(转)35 个毁掉你代码的不良习惯 !

作者|Christian Maioli M翻译|Viyi, leoxu, stevobm来源 | https://www.oschina.net/ 坏习惯很难改变,如果你不知道你的坏...
  • eininotop
  • eininotop
  • 2017年05月16日 08:29
  • 268

java 常用习惯用法总结

注:本文是根据网络上的文章受启发,自己再写代码总结而成。因为无法找到原文的原始出处,所以没法给出原文链接。文章也会引用部分网络素材内容,如果原作者看到请与我联系。前言本博主写java属于半道出家,与专...
  • bitcarmanlee
  • bitcarmanlee
  • 2016年06月18日 00:18
  • 804

JavaScript代码不好读,不好维护?你需要改变写代码的习惯

良好的编码习惯,这是每个程序员应具备的最基本素质。无论是前端程序员还是后端程序员,都要遵循基本的规范,减少因代码混乱而造成难以维护的局面。要做到不管有多少人共同参与同一个项目,一定要确保每一行代码都像...
  • u013794666
  • u013794666
  • 2015年03月18日 18:04
  • 520

javascript 代码编写习惯

良好的编码习惯,这是每个程序员应具备的最基本素质。无论是前端程序员还是后端程序员,都要遵循基本的规范,减少因代码混乱而造成难以维护的局面。要做到不管有多少人共同参与同一个项目,一定要确保每一行代码都像...
  • yemao100
  • yemao100
  • 2015年03月20日 09:13
  • 226

python 编码规范及习惯写法范例

python代码习惯写法:转自  http://www.fantascienza.net/leonardo/ar/python_best_practices.html python代码编写过程中有一...
  • chenbaoke
  • chenbaoke
  • 2014年08月19日 18:13
  • 1399

java良好的编程习惯

java良好的编程习惯 1.应该在每个程序的开始都加上注释,解释该程序的目的、作者以及程序最后一次被修改的日期和时间。 2.使用空行和空格来增强程序的可读性。 3.按照约定,类名标识...
  • javaniuniu
  • javaniuniu
  • 2017年05月29日 15:15
  • 430

良好的代码习惯(一)

【《代码整洁之道》精读与演绎】之一 让代码比你来时更干净 标签: clean code读书笔记代码整洁之道 2016-07-31 19:00 9965人阅读 评论(23) 收藏 举报 ...
  • Acmer_Sly
  • Acmer_Sly
  • 2016年08月16日 22:27
  • 1223

java 编程好习惯(待总结)

 您可以在一条语句中声明很多变量。该语句以 var 开头,并使用逗号分隔变量即可: var name="Gates", age=56, job="CEO"; 声明也可横跨多行: var n...
  • u013538740
  • u013538740
  • 2014年04月08日 14:49
  • 959

养成好的JAVA编码习惯

最近的机器内存又爆满了,除了新增机器内存外,还应该好好review一下我们的代码,有很多代码编写过于随意化,这些不好的习惯或对程序语言的不了解是应该好好打压打压了。   下面是参考网络资源...
  • lifuxiangcaohui
  • lifuxiangcaohui
  • 2014年05月07日 17:14
  • 1375

java开发中的一些好的原则和习惯

java开发中的一些好的原则和习惯
  • wangyanming123
  • wangyanming123
  • 2016年07月13日 08:44
  • 403
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:Android 代码编写习惯
举报原因:
原因补充:

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