首页
学习
活动
专区
圈层
工具
发布
社区首页 >问答首页 >JAutodoc vs Checkstyle:你知道有什么工具可以测量或检查高质量的javadoc吗?

JAutodoc vs Checkstyle:你知道有什么工具可以测量或检查高质量的javadoc吗?
EN

Stack Overflow用户
提问于 2012-01-12 20:20:02
回答 1查看 613关注 0票数 1

为了通过检查样式的发现,一些开发人员简单地在他们的代码上运行JAutodoc,这会产生如下所示的无意义的注释。IMHO,任何自动化文档都是不好的,因为它不会给我从名字中获得的信息增加任何东西。

有没有什么工具可以测量或检查更高质量的javadoc-comments?我想我不能期望自然语言处理,但也许还有其他想法/工具...

代码语言:javascript
复制
/** 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;
}
EN

回答 1

Stack Overflow用户

发布于 2012-01-12 20:31:11

您是否考虑过与开发人员交谈并询问他们为什么要这样做?

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

代码语言:javascript
复制
 /**
 * Returns the messageIdentification.
 * 
 * @return the messageIdentification.
 */
public String getMessageIdentification() {
    return messageIdentification;
}
票数 3
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/8834991

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档