java - 为 Javadoc 注释不稳定的类/方法

Question

在为 Java 项目开发新类/方法时，有时您想让人们试用您的新代码，但又不想保证它在未来的版本中会向后兼容。在这种情况下，使用 @Unstable 注释之类的东西来通知用户此代码在稳定之前不会具有向后兼容性保证是有意义的(@Unstable 功能不同于 @Deprecated 功能，因为它可能会被更改或删除而不被视为重大更改)。还需要将此类注释反射(reflect)在 javadoc 生成的 HTML 中，以便用户了解它们。非常乐观，如果您使用带有 @Unstable 注释的代码，那么编译器警告也会很有帮助。

Java 中是否有针对此类功能的标准？如果没有，是否可以自定义 javadoc 以允许此类功能？

Answer 1

不，Java 中没有针对此类功能的标准。

要将此信息添加到生成的 Javadoc，您可以在自己的注释上使用 @Documented。

import java.lang.annotation.Documented;

@Documented
public @interface Unstable {
}

注解将出现在注解类型、字段、方法等的 Javadoc 中。

public interface AlwaysChangingApi {
    @Unstable
    String process(String someParameter);
}