个人编码模板

最新推荐文章于 2021-01-01 14:53:17 发布

「已注销」

最新推荐文章于 2021-01-01 14:53:17 发布

阅读量366

点赞数

本文链接：https://blog.csdn.net/zhaoxqzz/article/details/82227812

版权

1.有关命名

1.1 包命名

包命名采用全小写命名；
通过功能来命名；
类命名采用Pascal命名法；
大写字母开头，各个单词首字母大写；
Activity、Fragment、Service等命名必须以Activity、Fragment、Service相应后缀结束；
Model命名变量采用public修饰；
方法命名采用Camel命名法，小写字母开头，各个单词首字母大写；
属性的getter和setter方法尽量使用自动生成，并放在程序的后面；
Boolean类型的属性的get方法应形如isProperty()；
使用getXXX()形式和setXXX()形式进行获取数据和设置数据的基本方法命名；
采用Camel命名法，小写字母开头，各个单词首字母大写；
特有大写缩写词汇保持大写如：SQL
尽量采用全命名方式，名字确实过长时，可适当采用缩减英文元音字母来缩短长度；
假如缩短后名字重复，可以保留其中一个的部分元音字母；
类内部变量命名时，需要带上m开头，表示此为类内部变量成员；
控件在命名时保持与layout中id一致命名原则；
采用全大写命名法，有意义的单词之间使用"_"进行分割；
采用全小写命名法；
所有的字母均小写，单词之间以下划线'_'分隔；
按照分类+功能+所属页面等命名，如：layout_main.xml，item_bluetooth_device.xml,view_switch_button.xml,dialog_add.xml等；
图标文件默认使用ic_开头，例如ic_logo；
控件样式文件等以控件缩写开头，描述控件目标，例如btn_ background _light.9.png；
原则上采用全小写命名法，并采用下划线分割法；
控件id在冲突的情况下需要加入页面限定，例如：tv_username_activity_main等；

1.2 类命名

1.3 方法命名

1.4 变量命名

1.4.1 一般性原则

1.4.2控件命名原则

1.5 常量命名

1.6 资源文件命名

1.7 其他命名

备注：各个控件以首字母缩写为基本原则，个别控件可根据实际情况使用全命名方式，但必须小写开头，命名前缀一览；

2 有关注释

2.1 程序文件头注释

应该包含如下：
* 文件描述（Description）：描述此类的作用；
* 作者（Author）：创建者或者修改者名；
* 版本（Version）：创建或者修复时的编号，需要自行在bug管理系统中创建bug 号，使用bug号进行命名（若无bug管理工具的临时办法：如无bug号，从1开始，修改时依次增加）
* 日期（Date）：创建或者修改时的日期，使用“-”进行年月日分割；

* 记录（Record）：创建或者修改的工作内容描述；

提前设置好文件的模板Template，模板以下：

/**

* Description:

* Author Version Date Record

* KevinLee 1 2017-11-7 版本创建

2.2 方法头注释

       一般在写完一个方法后使用快捷键生成一个块注释，IDE会自动帮我们写入一些信息。
应该包含如下信息：
       * 方法描述 Description:
       * 参数信息 @param
       * 返回信息 @return
       * 异常信息 @Exception
       如以下模板：

/**

* Description: 返回一个“Hello”字符串

* @param str 一个字符串

* @return 返回一个字符串

* @throws Exception 抛出一个异常

public String sayHello(String str) throws Exception{

str="Hello";

return str;

}

注意：方法里面不要使用块注释