注释Javadoc的不稳定类/方法

Question

在为Java项目开发新的类/方法时，有时您想让人们试用您的新代码，但又不想保证它在未来的版本中向后兼容。在这种情况下，使用@不稳定注释来通知用户该代码在稳定之前不会有向后兼容性保证是有意义的(@不稳定特性不同于@Deprecated特性，因为它可以被更改或删除而不会被认为是破坏性更改)。这样的注释也有必要反映在javadoc生成的HTML中，以便用户能够注意到它们。非常乐观，如果您正在使用注释为@不稳定的代码，那么编译器警告也会有所帮助。

在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);
}