Comments JAutodoc vs Checkstyle:你知道一种测量或检查Javadoc质量的工具吗?

Comments JAutodoc vs Checkstyle:你知道一种测量或检查Javadoc质量的工具吗?,comments,javadoc,qa,checkstyle,jautodoc,Comments,Javadoc,Qa,Checkstyle,Jautodoc,为了传递checkstyle的发现,一些开发人员只需在他们的代码上运行JAutodoc,这会产生无意义的注释,如下所示。我的意思是,任何自动文档都是糟糕的,因为它不会增加我从名字中获得的信息 是否有任何工具可以测量或检查质量更好的javadoc注释?我想我不能期望自然语言处理,但也许还有其他想法/工具 /** The message identification. */ private String messageIdentification; /** * Returns the messa

为了传递checkstyle的发现,一些开发人员只需在他们的代码上运行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;
}
您是否考虑过与开发人员交谈并询问他们为什么这样做

另一方面,这个getter真的需要javadoc吗?消息标识到底是什么?能给它起个更好的名字吗

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

这不是问题所在。请继续讨论这个话题。“但也许还有其他想法/工具。”-我只是指出,强迫人们为他们可能觉得不需要的方法编写javadoc会让他们使用工具来加速任务。如果你不喜欢这个答案,就投反对票。