Javadoc несколько переменных в одной строке - PullRequest
Новая
       1

Javadoc несколько переменных в одной строке

9 голосов
/ 12 марта 2012

У меня есть класс, подобный следующему ... 

class A{

/**
 * Blah blah
 */
 Type1 var;

/**
 * What do I do here?
 */
 Type2 var11, var12;

}

Как я могу javadoc var11 и var12, если они оба находятся на одной строке?

Мне любопытно посмотретьесли это возможно, я знаю, что могу поместить их как в отдельную строку, так и в javadoc оттуда.

Ответы [ 2 ]

10 голосов
/ 12 марта 2012

Мне было любопытно, поэтому я попробовал это 

/**
 * data stuff
 */
 int x , y ;

Полученный Javadoc повторял одни и те же комментарии к документам для x и y. Я полагаю, что такое поведение было бы полезно, если бы два поля были практически одинаковыми с небольшими отличиями. 

class Circle
{
    ....
    /**
     * center coordinates
     * The x/y coordinate of the center of this circle.
     */
     int x , y ;
0 голосов
/ 10 июля 2016

к сожалению, нет способа дифференцировать однострочное объявление нескольких переменных: (

Может быть полезно отметить, однако, что преимущество этого позволяет одному Javadoc предоставлять документацию для категориальных переменных, которые в противном случае могут занять ненужные строки. 

/**
 * custom colors (MUST BE DISPOSED!)
 */
Color lightblue, someotherblue, lightred;

Конечно, это также может быть объединено с инициализацией 

/**
*  These are the spec's behind batch-box font size / Height / Width
*/
private int iFontHeight = 9, iboxheight = 58, iboxwidth = 125;
...