Question

根据JLS（§8.4.3），方法修饰符的首选顺序是

Annotation public protected private abstract static final synchronized native strictfp

前提是注释（如果有）适用于方法（@Target(METHOD)）。另一方面（§9.7.4），非void方法的返回类型的任何类型注释都应该紧跟在类型之前。

所以如果我们有一个方法注释：

@Target(METHOD)
@interface MethodAnnotation {
}

和类型注释：

@Target(TYPE_USE)
@interface TypeAnnotation {
}

然后右侧（根据首选编码样式）样本方法的修饰符顺序为

@MethodAnnotation
public static @TypeAnnotation T foo() {
    // ...
}

现在考虑我们有一个＆＃34;混合＆＃34;适用于方法和类型的注释：

package com.example;

import java.lang.annotation.Retention;
import java.lang.annotation.Target;

import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.ElementType.TYPE_USE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

@Retention(RUNTIME)
@Target({METHOD, TYPE_USE})
@interface MethodOrTypeAnnotation {
        // empty
}

在方法上使用时，此类注释将应用于两者方法及其返回类型。那么首选的代码风格是什么？

public static @MethodOrTypeAnnotation T foo() {
        // ...
}

或者以下版本可能更好？

@MethodOrTypeAnnotation
public static T foo() {
        // ...
}

Answer 1

将注释声明为类型注释和声明注释bad style。你应该避免创建这样的注释。

注释以一些@Nullable或@NonNull注释为例，这些注释旨在用于处理类型注释的现代工具以及在Java具有类型注释之前编写的旧工具。这种类型和声明注释是一种临时措施，旨在在工具支持Java 8之前使用，并且不再需要。 link above提供了其他示例以及如何避免它们。

也就是说，如果你有一个Frankenstein类型和声明注释，最好将它写在代表其主要含义的位置或在此上下文中使用的位置。实际上，该属性通常是一个类型属性，因此注释应该与其他类型注释一起写在类型前面。

注释方法的首选修饰符顺序

1 个答案: