(/*……*/)如果有必要的
话
作为类/接口文档注释。
4
类的(静态)变量
首先是类的公共变量,随后是保护变量,再后是包一级别的变量(没
有访问修饰符,access modifier),最后是私有变量。
5
实例变量
首先是公共级别的,随后是保护级别的,再后是包一级别的(没有访
问修饰符),最后是私有级别的。
6
构造器
7
方法
这些方法应该按功能,而非作用域或访问权限,分组。例如,一个
私有的类方法可以置于两个公有的实例方法之间。其目的是为了更
便于阅读和理解代码。
4 缩进排版(Indentation)
4 个空格常被作为缩进排版的一个单位。缩进的确切解释并未详细指定(空格 vs. 制表符)。一
个制表符等于 8 个空格(而非 4 个)。
4.1 行长度(Line Length)
尽量避免一行的长度超过 80 个字符,因为很多终端和工具不能很好处理之。
注意:用于文档中的例子应该使用更短的行长,长度一般不超过 70 个字符。
4.2 换行(Wrapping Lines)
当一个表达式无法容纳在一行内时,可以依据如下一般规则断开之:
- 在一个逗号后面断开
- 在一个操作符前面断开
- 宁可选择较高级别(higher-level)的断开,而非较低级别(lower-level)的断开
- 新的一行应该与上一行同一级别表达式的开头处对齐
- 如果以上规则导致你的代码混乱或者使你的代码都堆挤在右边,那就代之以缩进 8 个空格。
以下是断开方法调用的一些例子:
someMethod(longExpression1, longExpression2, longExpression3,
longExpression4, longExpression5);
var = someMethod1(longExpression1,
someMethod2(longExpression2,
longExpression3));
以下是两个断开算术表达式的例子。前者更好,因为断开处位于括号表达式的外边,这是个较高
级别的断开。