锐客网

  1. 首页 > 睿知 > it技术 > >

java编码代码规范 java编码规范和格式的要求( 十 )

IT技术标号


若你想给出有关类、接口、变量或方法的信息，而这些信息又不适合写在文档中，则可使用实现块注释(见5.1.1)或紧跟在声明后面的单行注释(见5.1.2) 。例如，有关一个类实现的细节，应放入紧跟在类声明后面的实现块注释中 ， 而不是放在文档注释中 。
文档注释不能放在一个方法或构造器的定义块中，因为Java会将位于文档注释之后的第一个声明与其相关联 。
6 声明(Declarations)
6.1 每行声明变量的数量(Number Per Line)
推荐一行一个声明 ， 因为这样以利于写注释 。亦即，
int level;// indentation level
int size;// size of table
要优于，
int level, size;
不要将不同类型变量的声明放在同一行，例如：
int foo,fooarray[];//WRONG!
注意：上面的例子中，在类型和标识符之间放了一个空格，另一种被允许的替代方式是使用制表符：
intlevel;// indentation level
intsize;// size of table
Object currentEntry;// currently selected table entry
6.2 初始化(Initialization)
尽量在声明局部变量的同时初始化 。唯一不这么做的理由是变量的初始值依赖于某些先前发生的计算 。
6.3 布局(Placement)
只在代码块的开始处声明变量 。（一个块是指任何被包含在大括号"{"和"}"中间的代码 。）不要在首次用到该变量时才声明之 。这会把注意力不集中的程序员搞糊涂 ， 同时会妨碍代码在该作用域内的可移植性 。
void myMethod() {
int int1 = 0;// beginning of method block
if (condition) {
int int2 = 0;// beginning of "if" block
...
}
}
该规则的一个例外是for循环的索引变量
for (int i = 0; imaxLoops; i++) { ... }
避免声明的局部变量覆盖上一级声明的变量 。例如，不要在内部代码块中声明相同的变量名：
int count;
...
myMethod() {
if (condition) {
int count = 0;// AVOID!
...
}
...
}
6.4 类和接口的声明(Class and Interface Declarations)
当编写类和接口是 ， 应该遵守以下格式规则：
- 在方法名与其参数列表之前的左括号"("间不要有空格
- 左大括号"{"位于声明语句同行的末尾
- 右大括号"}"另起一行，与相应的声明语句对齐，除非是一个空语句 ， "}"应紧跟在"{"之后
class Sample extends Object {
int ivar1;
int ivar2;
Sample(int i, int j) {
ivar1 = i;
ivar2 = j;
}
int emptyMethod() {}
...
}
- 方法与方法之间以空行分隔
7 语句(Statements)
7.1 简单语句(Simple Statements)
每行至多包含一条语句，例如：
argv++;// Correct
argc--;// Correct
argv++; argc--;// AVOID!
7.2 复合语句(Compound Statements)
复合语句是包含在大括号中的语句序列，形如"{ 语句 }" 。例如下面各段 。
- 被括其中的语句应该较之复合语句缩进一个层次
- 左大括号"{"应位于复合语句起始行的行尾；右大括号"}"应另起一行并与复合语句首行对齐 。
- 大括号可以被用于所有语句，包括单个语句 ， 只要这些语句是诸如if-else或for控制结构的一部分 。这样便于添加语句而无需担心由于忘了加括号而引入bug 。
7.3 返回语句(return Statements)
一个带返回值的return语句不使用小括号"()" ， 除非它们以某种方式使返回值更为显见 。例如：
return;
return myDisk.size();
return (size ? size : defaultSize);
7.4 if，if-else，if else-if else语句(if, if-else, if else-if else Statements)
if-else语句应该具有如下格式：
if (condition) {

推荐阅读


上一篇：u盘上怎么打开jb文件，u盘里的文件怎么打开

下一篇：抖音开直播怎么分享屏幕，抖音直播如何共享手机屏幕