为了通过 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;
}