Java编程规范

最新推荐文章于 2021-12-10 18:30:03 发布

acm_hmj

最新推荐文章于 2021-12-10 18:30:03 发布

阅读量603

点赞数 1

分类专栏： java

java 专栏收录该内容

5 篇文章 0 订阅

订阅专栏

为什么要有编码规范？

一个软件的生命周期中，80%的花费在于维护
几乎没有任何一个软件，在其整个生命周期中，均由最初的开发人员来维护
编码规范可以改善软件的可读性，可以让程序员尽快而彻底地理解新的代码
如果你将源码作为产品发布，就需要确任它是否被很好的打包并且清晰无误，一如你已构建的其它任何产品

为了执行规范，每个软件开发人员必须一致遵守编码规范。每个人。

Java命名规范

1，Java源文件

每个Java源文件都包含一个单一的公共类或接口。若私有类和接口与一个公共类相关联，可以将它们和公共类放入同一个源文件。公共类必须是这个文件中的第一个类或接口。

2，开头注释

/*
* Classname
*
* Version information
*
* Date
*
* Copyright notice
*/

3，包和引入语句

在多数Java源文件中，第一个非注释行是包语句。在它之后可以跟引入语句。例如：

package java.awt;

import java.awt.peer.CanvasPeer;

4，类和接口声明(Class and Interface Declarations)

类/接口声明的各部分注解
1 类/接口文档注释(/*……/) 该注释中所需包含的信息，
2 类或接口的声明
3 类/接口实现的注释(/……/)如果有必要的话该注释应包含任何有关整个类或接口的信息，而这些信息又不适合作为类/接口文档注释。
4 类的(静态)变量首先是类的公共变量，随后是保护变量，再后是包一级别的变量(没有访问修饰符，access modifier)，最后是私有变量。
5 实例变量首先是公共级别的，随后是保护级别的，再后是包一级别的(没有访问修饰符)，最后是私有级别的。
6 构造器
7 方法这些方法应该按功能，而非作用域或访问权限，分组。例如，一个私有的类方法可以置于两个公有的实例方法之间。其目的是为了更便于阅读和理解代码。

5，缩进排版(Indentation)

1，行长度(Line Length)

尽量避免一行的长度超过80个字符，因为很多终端和工具不能很好处理之。

2，换行(Wrapping Lines)

当一个表达式无法容纳在一行内时，可以依据如下一般规则断开之：

在一个逗号后面断开
在一个操作符前面断开
宁可选择较高级别(higher-level)的断开，而非较低级别(lower-level)的断开
新的一行应该与上一行同一级别表达式的开头处对齐
如果以上规则导致你的代码混乱或者使你的代码都堆挤在右边，那就代之以缩进8个空格。

6，注释

注释应被用来给出代码的总括，并提供代码自身没有提供的附加信息。注释应该仅包含与阅读和理解程序有关的信息。多余的的注释很容易过时。通常应避免那些代码更新就可能过时的注释。

注意：频繁的注释有时反映出代码的低质量。当你觉得被迫要加注释的时候，考虑一下重写代码使其更清晰。

注释不应写在用星号或其他字符画出来的大框里。注释不应包括诸如制表符和回退符之类的特殊字符。

程序可以有4种实现注释的风格：块(block)、单行(single-line)、尾端(trailing)和行末(end-of-line)。

1，块注释

块注释通常用于提供对文件，方法，数据结构和算法的描述。块注释被置于每个文件的开始处以及每个方法之前。它们也可以被用于其他地方，比如方法内部。在功能和方法内部的块注释应该和它们所描述的代码具有一样的缩进格式。

块注释之首应该有一个空行，用于把块注释和代码分割开来，比如：

/*
* Here is a block comment.
*/

2，单行注释(Single-Line Comments)

短注释可以显示在一行内，并与其后的代码具有一样的缩进层级。如果一个注释不能在一行内写完，就该采用块注释。单行注释之前应该有一个空行。以下是一个Java代码中单行注释的例子：

if (condition) {

/* Handle the condition. */
…
}

3 ，尾端注释(Trailing Comments)

极短的注释可以与它们所要描述的代码位于同一行，但是应该有足够的空白来分开代码和注释。若有多个短注释出现于大段代码中，它们应该具有相同的缩进。

以下是一个Java代码中尾端注释的例子：

if (a == 2) {
return TRUE; /* special case */
} else {
return isPrime(a); /* works only for odd a */
}

4，行末注释

注释界定符”//”，可以注释掉整行或者一行中的一部分。它一般不用于连续多行的注释文本；然而，它可以用来注释掉连续多行的代码段。以下是所有三种风格的例子：

if (foo > 1) {

// Do a double-flip.
…
}
else {
return false; // Explain why here.
}

//if (bar > 1) {
//
// // Do a triple-flip.
// …
//}
//else {
// return false;
//}

7，声明(Declarations)

推荐一行一个声明，因为这样以利于写注释。

int level; // indentation level
int size; // size of table

尽量在声明局部变量的同时初始化。唯一不这么做的理由是变量的初始值依赖于某些先前发生的计算。

只在代码块的开始处声明变量。（一个块是指任何被包含在大括号”{“和”}”中间的代码。）不要在首次用到该变量时才声明之。这会把注意力不集中的程序员搞糊涂，同时会妨碍代码在该作用域内的可移植性。

避免声明的局部变量覆盖上一级声明的变量。例如，不要在内部代码块中声明相同的变量名。

当编写类和接口是，应该遵守以下格式规则：

在方法名与其参数列表之前的左括号”(“间不要有空格
左大括号”{“位于声明语句同行的末尾
右大括号”}”另起一行，与相应的声明语句对齐，除非是一个空语句，”}”应紧跟在”{“之后
方法与方法之间以空行分隔

class Sample extends Object {
int ivar1;
int ivar2;

Sample(int i, int j) {
ivar1 = i;
ivar2 = j;
}

int emptyMethod() {}

…
}

8，空白

1 空行

空行将逻辑相关的代码段分隔开，以提高可读性。

下列情况应该总是使用两个空行：

一个源文件的两个片段(section)之间
类声明和接口声明之间

下列情况应该总是使用一个空行：

两个方法之间
方法内的局部变量和方法的第一条语句之间
块注释（参见”5.1.1”）或单行注释（参见”5.1.2”）之前
一个方法内的两个逻辑段之间，用以提高可读性

2 空格(Blank Spaces)

下列情况应该使用空格：

一个紧跟着括号的关键字应该被空格分开，例如：

while (true) {
…
}

注意：

空格不应该置于方法名与其左括号之间。这将有助于区分关键字和方法调用。
空白应该位于参数列表中逗号的后面。
所有的二元运算符，除了”.”，应该使用空格将之与操作数分开。
一元操作符和操作数之间不因该加空格，比如：负号、自增自增。
for语句中的表达式应该被空格分开。
强制转型后应该跟一个空格。

9 命名规范(Naming Conventions)

命名规范使程序更易读，从而更易于理解。它们也可以提供一些有关标识符功能的信息，以助于理解代码，例如，不论它是一个常量，包，还是类。

包(Packages)命名规则：

一个唯一包名的前缀总是全部小写的ASCII字母并且是一个顶级域名，通常是com，edu，gov，mil，net，org，或1981年ISO 3166标准所指定的标识国家的英文双字符代码。包名的后续部分根据不同机构各自内部的命名规范而不尽相同。这类命名规范可能以特定目录名的组成来区分部门(department)，项目(project)，机器(machine)，或注册名(login names)。
com.sun.eng
com.apple.quicktime.v2
edu.cmu.cs.bovik.cheese

类(Classes) 命名规则：

类名是个一名词，采用大小写混合的方式，每个单词的首字母大写。尽量使你的类名简洁而富于描述。使用完整单词，避免缩写词(除非该缩写词被更广泛使用，像URL，HTML) class Raster;
class ImageSprite;

接口(Interfaces) 命名规则：

大小写规则与类名相似 interface RasterDelegate;
interface Storing;

方法(Methods) 命名规则：

方法名是一个动词，采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写。
run();
runFast();
getBackground();

变量(Variables) 命名规则：

除了变量名外，所有实例，包括类，类常量，均采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写。变量名不应以下划线或美元符号开头。

变量名应简短且富于描述。变量名的选用应该易于记忆，即，能够指出其用途。尽量避免单个字符的变量名，除非是一次性的临时变量。临时变量通常被取名为i，j，k，m和n，它们一般用于整型；c，d，e，它们一般用于字符型。
char c;
int i;
float myWidth;

实例变量(Instance Variables)命名规则：

大小写规则和变量名相似，除了前面需要一个下划线
int _employeeId;
String _name;
Customer _customer;

常量(Constants)命名规则：
类常量和ANSI常量的声明，应该全部大写，单词间用下划线隔开。(尽量避免ANSI常量，容易引起错误)
static final int MIN_WIDTH = 4;
static final int MAX_WIDTH = 999;
static final int GET_THE_CPU = 1;

10 编程惯例(Programming Practices)

1 ，提供对实例以及类变量的访问控制(Providing Access to Instance and Class Variables)

若没有足够理由，不要把实例或类变量声明为公有。通常，实例变量无需显式的设置(set)和获取(gotten)，通常这作为方法调用的边缘效应 (side effect)而产生。

一个具有公有实例变量的恰当例子，是类仅作为数据结构，没有行为。亦即，若你要使用一个结构(struct)而非一个类(如果java支持结构的话)，那么把类的实例变量声明为公有是合适的。

2，引用类变量和类方法(Referring to Class Variables and Methods)

避免用一个对象访问一个类的静态变量和方法。应该用类名替代。例如：

classMethod(); //OK
AClass.classMethod(); //OK
anObject.classMethod(); //AVOID!

3，常量(Constants)

位于for循环中作为计数器值的数字常量，除了-1,0和1之外，不应被直接写入代码。

4，变量赋值(Variable Assignments)

避免在一个语句中给多个变量赋相同的值。它很难读懂。例如：

fooBar.fChar = barFoo.lchar = ‘c’; // AVOID!

不要将赋值运算符用在容易与相等关系运算符混淆的地方。例如：

if (c++ = d++) { // AVOID! (Java disallows)
…
}

应该写成

if ((c++ = d++) != 0) {
…
}

不要使用内嵌(embedded)赋值运算符试图提高运行时的效率，这是编译器的工作。例如：

d = (a = b + c) + r; // AVOID!

应该写成

a = b + c;
d = a + r;

附：
原文出处：http://java.sun.com/docs/codeconv/html/CodeConvTOC.doc.html，
译文出处：http://morningspace.51.net/

acm_hmj

关注

1
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
Java编程规范

为什么要有编码规范？一个软件的生命周期中，80%的花费在于维护几乎没有任何一个软件，在其整个生命周期中，均由最初的开发人员来维护编码规范可以改善软件的可读性，可以让程序员尽快而彻底地理解新的代码如果你将源码作为产品发布，就需要确任它是否被很好的打包并且清晰无误，一如你已构建的其它任何产品为了执行规范，每个软件开发人员必须一致遵守编码规范。每个人。Java命名规范1，Java源文件每个Jav
复制链接

扫一扫