用于生成 JavaDoc 的 Java 自定义注释和文档处理器

Question

如何使用自定义注释自动创建 javadoc？

我曾尝试使用我的 IDE intellij 生成一个 javadoc，但它当然不会与我的自定义注释交互。 示例代码片段

@JavaDoc(
description = "adds two numbers together",
parameters = {"first number","second number"},    
return = {"the sum of the two input numbers}
)

public int pointCoordinat(int a, int b) {
return a + b;
}

我想要的只是让我的 JavaDoc 包含写在我的自定义注释上的文本，我不知道如何。

Answer 1

如果您使用@Documented注释您的注释，您的注释将包含在生成的 javadoc 中。 例如

@Documented
public @interface JavaDoc {
    String description();
}

但是，这不允许将注释中的参数视为 javadoc 注释标签，如果需要，则需要实现更复杂的内容...