锐客网

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

java代码块命名 java模块命名( 三 )

IT技术代码


...
}
if语句的换行通常使用8个空格的规则，因为常规缩进(4个空格)会使语句体看起来比较费劲 。比如：
//DON’T USE THIS INDENTATION
if ((condition1condition2)
|| (condition3condition4)
||!(condition5condition6)) { //BAD WRAPS
doSomethingAboutIt();//MAKE THIS LINE EASY TO MISS
}
//USE THIS INDENTATION INSTEAD
if ((condition1condition2)
|| (condition3condition4)
||!(condition5condition6)) {
doSomethingAboutIt();
}
//OR USE THIS
if ((condition1condition2) || (condition3condition4)
||!(condition5condition6)) {
doSomethingAboutIt();
}
这里有三种可行的方法用于处理三元运算表达式：
alpha = (aLongBooleanExpression) ? beta : gamma;
alpha = (aLongBooleanExpression) ? beta
: gamma;
alpha = (aLongBooleanExpression)
? beta
: gamma;
5 注释(Comments)
Java程序有两类注释：实现注释(implementation comments)和文档注释(document comments) 。实现注释是那些在C++中见过的，使用/*...*/和//界定的注释 。文档注释(被称为"doc comments")是Java独有的，并由/**...*/界定 。文档注释可以通过javadoc工具转换成HTML文件 。
实现注释用以注释代码或者实现细节 。文档注释从实现自由(implementation-free)的角度描述代码的规范 。它可以被那些手头没有源码的开发人员读懂 。
注释应被用来给出代码的总括，并提供代码自身没有提供的附加信息 。注释应该仅包含与阅读和理解程序有关的信息 。例如，相应的包如何被建立或位于哪个目录下之类的信息不应包括在注释中 。
在注释里，对设计决策中重要的或者不是显而易见的地方进行说明是可以的，但应避免提供代码中己清晰表达出来的重复信息 。多余的的注释很容易过时 。通常应避免那些代码更新就可能过时的注释 。
注意：频繁的注释有时反映出代码的低质量 。当你觉得被迫要加注释的时候，考虑一下重写代码使其更清晰 。
注释不应写在用星号或其他字符画出来的大框里 。注释不应包括诸如制表符和回退符之类的特殊字符 。
5.1 实现注释的格式(Implementation Comment Formats)
程序可以有4种实现注释的风格：块(block)、单行(single-line)、尾端(trailing)和行末(end-of-line) 。
5.1.1 块注释(Block Comments)
块注释通常用于提供对文件，方法，数据结构和算法的描述 。块注释被置于每个文件的开始处以及每个方法之前 。它们也可以被用于其他地方，比如方法内部 。在功能和方法内部的块注释应该和它们所描述的代码具有一样的缩进格式 。
块注释之首应该有一个空行，用于把块注释和代码分割开来，比如：
/*
* Here is a block comment.
*/
块注释可以以/*-开头，这样indent(1)就可以将之识别为一个代码块的开始，而不会重排它 。
/*-
* Here is a block comment with some very special
* formatting that I want indent(1) to ignore.
*
*one
*two
*three
*/
注意：如果你不使用indent(1)，就不必在代码中使用/*-，或为他人可能对你的代码运行indent(1)作让步 。
参见"文档注释"
5.1.2 单行注释(Single-Line Comments)
短注释可以显示在一行内，并与其后的代码具有一样的缩进层级 。如果一个注释不能在一行内写完，就该采用块注释(参见"块注释") 。单行注释之前应该有一个空行 。以下是一个Java代码中单行注释的例子：
if (condition) {
/* Handle the condition. */
...
}
5.1.3 尾端注释(Trailing Comments)
极短的注释可以与它们所要描述的代码位于同一行，但是应该有足够的空白来分开代码和注释 。若有多个短注释出现于大段代码中 ， 它们应该具有相同的缩进 。

推荐阅读


上一篇：python代码无颜色，python代码颜色搭配

下一篇：如何查看电商，如何查看电商最低价