注释
声明注释应与注释声明分开。
@SuppressWarnings("unchecked")
public T[] toArray(T[] typeHolder) {
...
}
但是,如果提高可读性,则可以将注释单行方法的少量或短注释放在与该方法相同的行上。例如,有人可能写道:
@Nullable String getName() { return name; }
为了保持一致性和可读性,要么将所有注释放在同一行,要么将每个注释放在单独的行上。
// Bad.
@Deprecated @SafeVarargs
@CustomAnnotation
public final Tuple<T> extend(T... elements) {
...
}
// Even worse.
@Deprecated @SafeVarargs
@CustomAnnotation public final Tuple<T> extend(T... elements) {
...
}
// Good.
@Deprecated
@SafeVarargs
@CustomAnnotation
public final Tuple<T> extend(T... elements) {
...
}
// Good.
@Deprecated @SafeVarargs @CustomAnnotation
public final Tuple<T> extend(T... elements) {
...
}