拼写检查和Javadoc验证工具

7

如果这个问题是重复的,那我很抱歉。

实际上,我正在寻找一种自动化检查工具来识别:

  • 缺少 javadoc,
  • javadoc 不完整或
  • 缺少简要说明
  • 在 javadoc 注释中测试和识别拼写或语法错误。

我知道有一些可用于执行这些操作的工具,例如 checkstyleopen javadoc check 等。但如果有更多的工具可用,我需要建议,如果是的话,哪一个更适合我的需求。

2个回答

0

集成开发环境(IDE)通常在 javadocs 和注释中包含拼写检查功能。我知道 Eclipse 绝对有这个功能(http://www.eclipse.org/downloads/ - 选择适用于 Java 开发人员的 IDE,大小为 150mb)。

此外,你不必为问题是否重复而道歉 - 你的第一资源应该是谷歌,第二资源是 SO 搜索,第三资源是在输入标题时得到的“类似问题”框。


我已经进行了所有三个搜索,但有时答案可能已经存在,但可能不会在我的搜索查询中弹出,因此就有了第一行。我知道eclipse进行了拼写检查,但我想知道是否有一种工具可以执行漏洞检查和语法验证。 - rinku
嗯,我知道通常语法验证不会很好 - 不同地方的文档使用不同的语调。至于缺失的文档,您可以始终查看构建站点页面并检查是否有任何内容为空 :) - Riking
抱歉,我正在寻找一种自动化工具。我知道我可以手动检查,但对于200-300个类来说,这不是一个好主意。 - rinku
1
我猜Checkstyle可以为您完成这项工作(并找到许多其他代码“问题”)。 - Luiggi Mendoza

0
关于拼写和语法 - 在人们提交代码之前,您是否进行代码审查?那么拼写和语法检查呢?
对于已经存在的类 - 如果您真的需要更好的语法检查,您要么必须使用商业工具,要么编写自己的工具(例如,解析所有javadoc并在其上运行拼写和语法检查器的Python脚本)。

代码审查确实可以发现这种问题,但如果我是进行代码审查的人,我不想在审查中放置1000个关于所有错误拼写和标点符号的评论。这浪费了我的大量时间,也浪费了原始作者的大量时间,因为他们必须逐个修复并再次提交。 - Hakanai

网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接