关闭

Android 代码编写习惯

标签: android编码习惯规范
318人阅读 评论(0) 收藏 举报
分类:

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






1
0

查看评论
* 以上用户言论只代表其个人观点,不代表CSDN网站的观点或立场
    个人资料
    • 访问:8884次
    • 积分:220
    • 等级:
    • 排名:千里之外
    • 原创:12篇
    • 转载:0篇
    • 译文:0篇
    • 评论:3条
    文章分类
    最新评论