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

Question

在为Java项目开发新的类/方法时，有时您希望让人们试用您的新代码，但又不想保证它在将来的版本中将向后兼容。在这种情况下，使用@Unstable注释之类的东西来通知用户该代码在稳定之前将不具有向后兼容性保证（@Unstable功能与@Deprecated功能不同之处在于可以对其进行更改或删除），这是有意义的。而不被视为重大更改）。这些注释也必须反映在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);
}