Много копий сломано в обсуждениях комментариев в коде. Хочу поделиться одним типом комментов, которые мне, честно сказать, очень не нравятся, ибо они бессмысленны.
/** The timeout. */
private int timeout;
/**
Gets the timeout.
@return the timeout
*/
public int getTimeout() {
return timeout;
}
/**
Sets the timeout.
@param timeout the timeout to set
*/
public void setTimeout(int timeout) {
this.timeout = timeout;
}
Блин, серьезно? Нет, серьезно?! Зачем, зачем нужны такие джавадоки, зачем?! О, я понимаю, что это автосгенеренные комменты. Но зачем их оставлять, а в первую очередь - вообще вставлять? Это что, поможет кому-то, подскажет что-то?
И натыкаешься потом на два десятка параметров-методов, растянутые бессмысленными комментами на несколько экранов.
Но это еще полбеды. Самая беда - вот такое:
/** The notional date. */
private Date settlementDate;
/** Get the maturity date. */
public Date getTradeDate() {
return settlementDate;
}
Ну просто вашу ж мать.