您的位置:首页 > 编程语言 > Java开发

JAVA编码规范

2015-05-30 22:03 387 查看
JAVA编码规范
为什么要规范编码??

基本是从这三个方面考虑:

1)软件开发阶段,规范编码可以使项目开发的其他程序员理解你的代码。

2)软件生命周期中,80%的花费用在软件维护,规范编码可以让后期维护程序员快速而彻底的理解你写的代码。

3)软件发布时需要确定确定程序是否被很好的打包并清洗无误。

总而言之,就是增加代码的可读性。

代码编码要求:

1)类的命名空间和类文件的地址一致,类文件名和类名一致,调用类和类命名大小写一致;

2)函数定义使用小写字母并且单词间下划线分隔;

3)类定义使用驼峰命名法,类方法和属性驼峰命名法且首字母小写,私有方法和属性使用下划线开头;

4)双下划线开头表示魔法方法;

5)常量和配置参数使用大写字母,单词间用下划线分隔;

6)数据库和表使用小写字母,单词间用下划线分隔;

JAVA源文件  开头注释

Java源代码需要在源文件开头写出一个列举类名、版本信息、日期和版权声明的注释,该注释和C语言注释风格相似。

格式如下:

/*
* 移动文件到对应的文件夹
* @param  string $filename  文件名称
* @param  string $string  文件夹路径
* @return  bool 返回值
* @user jolon
* Copyright notice
*/


JAVA源代码  换行

当一个表达式或一句代码过长是需要换行,但是在哪里换行遵守一定的规则会使你的代码更加美观。

换行依据 的原则有一下几个方面:

在逗号处换行;
在更高级别的操作符处断开,不选择更低处。(比如括号外部)
在操作符前面断开。比如+、-操作符前面换行
举例:

longName1 = longName2 * (longName3 + longName4 - longName5)
+ 4 * longname6; //PREFFER
</pre><pre class="java" name="code">if ((condition1 && condition2)
|| (condition3 && condition4)
||!(condition5 && condition6)) {
doSomethingAboutIt();
}
或者
if ((condition1 && condition2) || (condition3 && condition4)
||!(condition5 && condition6)) {
doSomethingAboutIt();
}
</pre><pre class="java" name="code">三元运算表达式:
alpha = (aLongBooleanExpression) ? beta : gamma;
alpha = (aLongBooleanExpression) ? beta
: gamma;
alpha = (aLongBooleanExpression)
? beta
: gamma;
</pre><pre class="java" name="code">
内容来自用户分享和网络整理,不保证内容的准确性,如有侵权内容,可联系管理员处理 点击这里给我发消息
标签: