Android代码编写规范

最新推荐文章于 2022-08-23 17:11:03 发布

mingyu_star

最新推荐文章于 2022-08-23 17:11:03 发布

阅读量444

点赞数 2

分类专栏： Android代码规范

本文链接：https://blog.csdn.net/qq_38542099/article/details/72777985

版权

Android代码规范专栏收录该内容

0 篇文章 0 订阅

订阅专栏

代码规范

今天所说的代码规范主要涉及代码中各类名称的命名、代码格式以及代码注释三方面，以下内容中带着示例，正例或者反例。另外欢迎各路大神指错和补充。

一.首先是与命名相关的：

1.所有编程相关：
a.所有编程相关的命名不能以下划线或美元符号开始，也不能以下划线或美元符号结束。

反例：

b.所有编程相关的命名不可使用拼音与英语单词结合的方式，更不能直接使用中文。

注意：纯拼音的方式尽量不用。

反例：

c.所有编程相关的命名应禁止不规范的缩写。

反例：

2.包名：
包名需要小写，包名使用单数形式。

正例：

3.类名：
a.类名遵从大驼峰式命名，即每个单词的首字母大写。类名如果有复数含义，可以使用复数含义。
注意：领域模型的相关命名除外，例：DO,DTO,DAO,VO
正例：

b.抽象类：命名使用Abstract或Base开头；

异常类：命名用Exception结尾；
测试类：以要测试的类的名称开始，一Test结尾；
枚举类：名以Enum结尾。
接口：对于Service和DAO，一般实现类用Impl结尾；形容能力的接口名称，去相应的形容词做接口名。
注意：用到设计模式，需在命名中体现出具体模式。

4..
a.方法名、参数名、成员变量、局部变量遵从小驼峰式命名，即除去首个单词的首字母不大写，其余单词首字母大写。
正例：

b.接口类中的方法和属性不要加任何修饰符（public 也不要加）并加上javadoc注释，

注意：尽量不要在接口里定义变量，如果一定要定义变量，肯定是与接口方法相关，并且是整个应用的基础常量
正例：

c.常量命名：全部大写，单词间用下划线隔开。

注意：一定要语意明确，表达完整，不要怕名字过长

正例：

常量定义：

1.不允许出现任何魔法值（即未经定义的常量）直接出现在代码中

2. long或者Long初始赋值时，必须要大写的L，避免混淆
3.缓存相关的常量放在CacheConsts下;系统配置相关的类放在ConfigConsts下

5.
Service/DAO:
a.获取单个对象的方法用 get 前缀。
b.获取多个对象的方法用 list 前缀。
c.获取统计值的方法用count前缀。
d.插入的方法用 save （一般用这个）或者insert前缀。
e.删除的方法用 remove (一般用这个)或者delete前缀。
f.修改的方法用 update 前缀。

领域模型：
a.数据对象：xxxDO，xxx几位数据表名。
b.数据传输对象：xxxDTO,xxx为业务领域相关的名称。
c.展示对象：xxxVO,xxx一般为网页名称。
d.POJO是DO/DTO/BO/VO的统称，禁止命名为xxxPOJO。

二.接下来是代码格式：主要是空格，换行相关的规范

1. 大括号与换行：
左大括号前不换行；
左大括号后换行；
右大括号前换行；
右大括号后还有else等代码则不换行，表示终止则必须换行。
正例：

2. 超出单行长度限制换行

a.运算符与下文一起换行

正例：

b.方法调用的点与下文一起换行

正例：

c.多个参数超长，逗号之后换行

正例：

d.在括号前不换行

3. 括号与空格：
左括号与后一个字符之间不加空格；
同理，右括号与前一个字符之间不加空格。

4. 空格：
a.if/for/while/switch/do等保留字与左右括号之间必须加空格
b.任何运算符左右必须加一个空格

c.tab键设置成一个tab为4个空格

注意：AndroidStudio中设置方式：File --> Settings --> Editor -->Code Style -->Java

将其中的Tab size 选项里的数值改为4：

三.最后是代码的注释：
注释的注意事项：
1.所有类的注释必须加上创建者信息
2.注释可以用中文，注释要精确简单
3.代码修改后，要同时修改注释
4.注释代码，需要加上简单的说明，以免后续恢复时不明确

1. 文档注释：（即：javadoc）使用 /**内容*/ 规范
a.类、类属性、类方法
b.所有的抽象方法（包括接口中的方法）

正例：红色部分就是文档注释