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

时间:2019-01-13 07:50:18

标签: java annotations documentation-generation

如何使用自定义注释自动创建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包含自定义注释中写的文本,而我不知道该怎么做。

1 个答案:

答案 0 :(得分:0)

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

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

但是,这将不允许您将注释中的参数像javadoc注释标签一样对待,如果您需要实现一些更复杂的内容...