为 Javadoc 注释不稳定 Classes/Methods

Question

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

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

Answer 1

不，Java中没有这种功能的标准。

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

import java.lang.annotation.Documented;

@Documented
public @interface Unstable {
}

注解将出现在Java注解类型、字段、方法等的文档中

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

为 Javadoc 注释不稳定 Classes/Methods

Annotating Unstable Classes/Methods for Javadoc

java

javadoc