JAutodoc vs Checkstyle: знаете ли вы инструмент, который измеряет или проверяет качество Javadocs? - PullRequest
1 голос
/ 12 января 2012

Чтобы передать результаты контрольного стиля, некоторые разработчики просто запускают JAutodoc для своего кода, который выдает бессмысленные комментарии, как показано ниже.ИМХО, любая автоматизированная документация плохая, так как она ничего не добавляет к информации, которую я получаю из имен.

Есть ли какой-либо инструмент, который измеряет или проверяет javadoc-комментарии лучшего качества?Я предполагаю, что не могу ожидать обработки естественного языка, но возможно есть другие идеи / инструменты ...

/** The message identification. */
private String messageIdentification;

/**
 * Returns the messageIdentification.
 * 
 * @return the messageIdentification.
 */
public String getMessageIdentification() {
    return messageIdentification;
}

/**
 * Sets the messageIdentification.
 * 
 * @param messageIdentification the messageIdentification.
 */
public void setMessageIdentification(String messageIdentification) {
    this.messageIdentification = messageIdentification;
}

1 Ответ

3 голосов
/ 12 января 2012

Рассматривали ли вы , разговаривая с разработчиками и спрашивая их, почему они это делают?

С другой стороны - нужен ли этот геттер какой-либо javadoc?Что такое идентификация сообщения в любом случае?Может быть, лучше назвать его?

 /**
 * Returns the messageIdentification.
 * 
 * @return the messageIdentification.
 */
public String getMessageIdentification() {
    return messageIdentification;
}
...