书写简介规范的代码

最新推荐文章于 2023-07-28 21:15:00 发布

zJianFlys

最新推荐文章于 2023-07-28 21:15:00 发布

阅读量496

点赞数

分类专栏： android 基础

153 篇文章 0 订阅

订阅专栏

主要为了学习,来源android 高级进阶：https://github.com/ASCE1885/AdvancedAndroidExample,如有侵权,请留言....

java编码规范

Java文件锁子啊的package的声明,例如 package android.net.
Java 类需要使用到的依赖的引入 import语句,一般不建议使用通配符,例如 import android.annotation.*;,而应该引入具体的类,例如 import android.annotation.SdkConstant;.同时,Import语句要按照类型进行分组,不同的组以空格分割,例如静态导入的类要独立成组,第三方函数库引入的类也独立成组等,一般使用IDE的格式化功能会自动帮我们分好组。
Java 顶级类的定义,有且只有一个,但可以存在内部类定义.每个类中的成员需要按照某种逻辑进行排序,维护者也需要按照相同的逻辑去添加新的成员,而不是仅仅将新的成员放到最后面,同时,多个重载方法应该按顺序排放在一起,中间不要插入其他方法.

多使用花括号:例如 if、else、for、do、while等语句要和花括号一起使用,即使只有一条语句或者是空的，也要加上花括号，下面的写法是错误的，而且可能会在后面的代码维护中引入Bug。

if(is)
     Login();
else
     unLogin();

正确的做法是加上花括号。

if(is){
     Login();
}
else{
     unLogin();
}

列字符个数的限制:根据团队内部使用的显示器以及IDE具体问题具体分析,最终目的是保证代码良好的可阅读性,一般常见的是约定一行80个或100个字符,超过部分IDE自动换行.
空白的使用:不要把所有的代码都写在一起,需要按照逻辑分组,垂直方向的空白原则主要有：（1）方法体内,语句的逻辑分组之间使用空行；（2）类里面连续的成员(成员、构造方法、普通方法、嵌套内部类、静态初始化代码块等)之间加上空行。当然,也没有必要加上多个空行,一个就够了。