java doc 编写,java - 如何编写属性的Javadoc？

在为只包含属性和getter和setter(dto-style)的“简单”pojo类的属性/成员编写javadoc时，我经常发现自己陷入困境。

1)为属性编写javadoc

或者…

2)为getter编写javadoc

如果我为属性编写JavaDoc，那么当我稍后通过代码完成访问POJO时，我的IDE(Eclipse)将(自然)无法显示这一点。并且没有标准的JavaDoc标记允许我将getter JavaDoc链接到实际的属性JavaDoc。

一个例子：public class SomeDomainClass {

/**

* The name of bla bla bla

*/

private String name;

/**

* @return INSERT SOME SMART JAVADOC TAG LINKING TO name's javadoc

*/

public String getName() {

return name;

}

因此，基本上，当听到其他人如何让Eclipse IDE显示getter的javadoc属性描述时会很有趣，而不必复制javadoc注释。

到目前为止，我正在考虑让我的练习只记录getter而不是属性。但这似乎不是最好的解决办法…

最佳答案：

您可以在生成javadocs(使用-private)时包含私有成员，然后使用@link链接到该字段属性。public class SomeDomainClass {

/**

* The name of bla bla bla

*/

private String name;

/**

* {@link SomeDomainClass#name}

*/

public String getName() {

return name;

}

}

或者，如果您不想为所有私有成员生成JavaDoc，您可以有一个约定来记录所有getter，并在setter上使用@link。

public class SomeDomainClass {

private String name;

/**

* The name of bla bla bla

*/

public String getName() {

return name;

}

/**

* {@link SomeDomainClass#getName}

*/

public void setName(String name) {

this.name = name;

}

}