2012-03-11 8 views
9

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

class A{ 

/** 
* Blah blah 
*/ 
Type1 var; 

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

} 

Как Javadoc var11 и var12, если они оба на одной и той же линии?

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

+0

Не делайте этого. Объявлять и документировать одну переменную в строке. – EJP

ответ

9

мне было интересно, поэтому я попробовал его

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

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

class Circle 
{ 
    .... 
    /** 
    * center coordinates 
    * The x/y coordinate of the center of this circle. 
    */ 
    int x , y ; 
+0

Да, я тоже пришел к такому выводу. Ну, я думаю, нет никакого способа разделить Javadoc, спасибо за ваш ответ и усилие! –

+0

К сожалению, это работает только с тем же типом. Таким образом, строки, подобные 'private JButton testButton, JLabel testLabel', не будут работать. – Bowi

0

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

Это может быть полезно отметить, однако, что польза от этого действительно позволяет одной 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; 
Смежные вопросы