比如一私有方法,应该放在两共有方法之间,增加可读性
块注释不会被格式化,(如果不想用缩进可以用文档注释)例如
/*- * Here is a block comment with some very special * formatting that I want indent(1) to ignore. * * one * two * three */短注释可以出现在缩进到后面代码级别的单行上。 如果一个注释不能写在一行,它应该遵循块注释格式(见第5.1.1节)。 单行注释应该以空行开头。 这里有一个例子的单行注释在Java代码中:
if (condition) { /* Handle the condition. */ ...}很短的注释可以出现在与它们描述的代码相同的行上,但应该是转移得足够远,以使它们与声明分离。 如果有多个简短的评论出现在一大块代码中,它们应该缩进到同一个标签设置。例如:
if (a == 2) { return TRUE; /* special case */} else { return isPrime(a); /* works only for odd a */}//注释分隔符可以注释掉一个完整的行或仅部分行。 它不应该连续多行用于文本注释; 然而,它可以用于连续多行注释掉代码段。
if (foo > 1) { // Do a double-flip. ...}else{ return false; // Explain why here.}//if (bar > 1) {//// // Do a triple-flip.// ...//}//else{// return false;//}注意:有关注释格式的示例,请参见第18页的“Java源文件示例”这里描述。有关详细信息,请参阅“如何为Javadoc撰写文档注释”,其中包括关于文档评论标签的信息(@return,@param,@see): http://java.sun.com/products/jdk/javadoc/writingdoccomments.html 有关doc注释和javadoc的更多详细信息,请参阅javadoc主页: http://java.sun.com/products/jdk/javadoc/ 文档注释描述Java类,接口,构造函数,方法和字段。 每个文档注释设置在注释分隔符/*…/内,每个类有一个注释,接口或成员。 这个注释应该在声明之前出现:
is preferred over
int level, size;可接受的:
int level; // indentation levelint size; // size of tableObject currentEntry; // currently selected table entry将声明放在块的开头。 不要等到使用时才声明变量。(for循环例外)
void myMethod() { int int1 = 0; // beginning of method block if (condition) { int int2 = 0; // beginning of "if" block ... }}不要声明内部块中的相同变量名
int count;...myMethod() { if (condition) { int count; // AVOID! ... } ...}每行最多一句语句。
argv++; // Correctargc++; // Correctargv++; argc--; // AVOID!if语句最好加上{},避免以下容易出错的形式:
if (condition) //AVOID! THIS OMITS THE BRACES {}! statement;避免在单个语句中将多个变量分配给相同的值。 这是很难阅读。
fooBar.fChar = barFoo.lchar = 'c'; // AVOID!混合运算符尽量带括号,提高优先级的可读性
if (a == b && c == d) // AVOID!if ((a == b) && (c == d)) // USE可以用下边代码替换
return booleanExpression;同理:
if (condition) { return x;}return y;可以用下边代码替代
return (condition ? x : y);新闻热点
疑难解答