类和接口注释标签

1. @author

• 作用：用于标明类或接口的作者。

2. @version

• 作用：指明类或接口的版本号。

3. @since

• 作用：说明该类或接口从哪个版本开始引入。

方法注释标签

1. @param

• 作用：对方法的参数进行说明，需写明参数名和参数的具体描述。

2. @return

• 作用：描述方法的返回值，包含返回值的类型和含义。

3. @throws 和 @exception

• 作用：二者作用相同，用于说明方法可能抛出的异常，需注明异常类型和异常抛出的条件。

通用标签

1. {@link}

• 作用：在注释文本里创建对其他类、方法或字段的内联链接。

2. {@value}

• 作用：当用于静态常量时，会显示该常量的值。

/**
 * 这是一个用于演示 Java 文档注释标签的示例类。
 * 该类包含了一些方法和字段，用于展示如何使用各种文档注释标签。
 * 
 * @author Alice
 * @version 1.2
 * @since 1.8
 */
public class DocumentedClass {

    /**
     * 这是一个静态常量，表示最大尝试次数。
     * 其值为 {@value #MAX_ATTEMPTS}。
     */
    public static final int MAX_ATTEMPTS = 5;

    /**
     * 这是一个实例变量，用于存储用户的名称。
     */
    private String userName;

    /**
     * 构造函数，用于初始化用户名称。
     * 
     * @param name 用户的名称，不能为 null 或空字符串
     * @throws IllegalArgumentException 如果传入的名称为 null 或空字符串
     */
    public DocumentedClass(String name) {
        if (name == null || name.isEmpty()) {
            throw new IllegalArgumentException("用户名不能为 null 或空字符串");
        }
        this.userName = name;
    }

    /**
     * 获取用户名称。
     * 
     * @return 用户的名称
     */
    public String getUserName() {
        return userName;
    }

    /**
     * 尝试执行某个操作，最多尝试 {@link #MAX_ATTEMPTS} 次。
     * 
     * @param operation 要执行的操作，不能为 null
     * @return 如果操作成功执行返回 true，否则返回 false
     * @throws IllegalArgumentException 如果传入的操作对象为 null
     * @see Operation
     */
    public boolean tryOperation(Operation operation) {
        if (operation == null) {
            throw new IllegalArgumentException("操作对象不能为 null");
        }
        for (int i = 0; i < MAX_ATTEMPTS; i++) {
            if (operation.execute()) {
                return true;
            }
        }
        return false;
    }

    /**
     * 这是一个内部接口，表示一个可执行的操作。
     */
    @FunctionalInterface
    public interface Operation {
        /**
         * 执行操作的方法。
         * 
         * @return 如果操作成功执行返回 true，否则返回 false
         */
        boolean execute();
    }
}