简体   繁体   中英

Is there a way to refer bean's property (both getter and setter) in Javadoc?

Suppose I have a class with bean's property sum , which is implemented with setter void setSum(double value) and getter double getSum() .

Is it possible to refer this by single link in javadoc? Suppose I wish to describe some properties in class' preamble. For example, something like this:

/**
 * A Value class is a bunch of aggregation values
 * 
 * {@beanlink #sum} - sum of all values (hypothetic way)
 * 
 * {@link #getSum()} - sum of all values (conventional way)
 * 
 */

There isn't any @beanlink kind of tag in javadoc comments. See a full list of allowed tag javadoc of javadoc ;)

There is a -tag option that can be used to create custom tags. But that won't perfectly fit for your solution, ie creating links.

The technical post webpages of this site follow the CC BY-SA 4.0 protocol. If you need to reprint, please indicate the site URL or the original address.Any question please contact:yoyou2525@163.com.

 
粤ICP备18138465号  © 2020-2024 STACKOOM.COM