R
Roedy Green
How do you do the JavaDoc for methods of this form:
/**
* get bold version of description.
*
* @param desc description of this link.
*
* @return bold version of description.
*/
private static String bold( String desc )
{
return "<b>" + desc + "</b>";
}
There should be some standard way of doing them that does not have
redundant wording. I almost think such method don't deserve JavaDoc
at all. The JavaDoc on getters almost never tells you anything useful.
The docs come out like some old Monty Python sketch based on
belabouring the obvious.
/**
* get bold version of description.
*
* @param desc description of this link.
*
* @return bold version of description.
*/
private static String bold( String desc )
{
return "<b>" + desc + "</b>";
}
There should be some standard way of doing them that does not have
redundant wording. I almost think such method don't deserve JavaDoc
at all. The JavaDoc on getters almost never tells you anything useful.
The docs come out like some old Monty Python sketch based on
belabouring the obvious.