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

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

1 个答案: