编码规范体现出一个开发者的基本素质,良好的编码规范可以提高团队编码的效率,避免很多不必要的问题。今天分享一个标准的Java编码规范给大家,希望对于大家今后的开发工作带来帮助。
编码规范的意义
在项目开发维护中,编码规范作为开发规范的一个组成部分,是十分重要和必须的,它不仅仅是为了提高开发效率,也有利于降低后期维护开发的成本。编码规范的根本目的就是要让不仅代码可以一目了然,也可以很容易的理解开发人员所编写的代码程的用途和意义。由此,用来减少项目中因为开发维护人员的更替或由于长时间不维护造成的记忆模糊或混乱等情况带来的对代码所实现的真正功能的理解困难和歧义。另外也提高了代码复查效率和效果。
规范实施建议
不是为了规范而规范,以提高软件开发质量和效率为目标,辅以IDE等开发工具为保障,逐步改进编码规范化水平
对于格式规范、注释规范等部分规范的要求,可以通过使用eclipse/AndroidStudio自带的Format方法(快捷键:Ctrl+Shift+F)进行自动格式化,可以提高开发效率又符合编码规范。
编码规范文档本身需要定期不断的修正和完善,以符合实际开发规范的要求。
格式规范
a)缩进
使用配置文件进行格式化:
配置文件中一个TAB等于4个空格。
b)行长度
每行100字符
注: 使用eclipse自带的Format方法(快捷键:Ctrl+Shift+F)时,需要配置“Maximum line width”设置长度为100
c)声明
d)声明变量、常量
一行只声明一个变量或常量;
在代码块的开始处声明实例变量,不要在首次用到该变量时才声明【推荐】
e)声明类
左大括号”{“位于声明语句同行的末尾,右大括号”}”另起一行;
方法与方法之间以空行分隔
f)语句
可以使用eclipse自带的Format方法(快捷键:Ctrl+Shift+F)时 使用eclipse默认的“Control Statements ”格式化方法进行
注:if语句总是用”{“和”}”括起来
示例
class Example {
void bar() {
do {
} while (true);
try {
} catch (Exception e) {
} finally {
}
}
void foo2() {
if (true) {
return;
}
if (true) {
return;
} else if (false) {
return;
} else {
return;
}
}
}
g)空格的使用
等号左右必须各有一个空格:
button = null;
双目运算符左右必须各有一个空格:
imageWidth = imagePadding + imageSize;
标点符号后面必须跟一个空格
标点符号包