用于检查c / c ++源代码中注释拼写的Linux工具

Question

您建议使用哪种软件来检查c / c ++源代码中包含的注释的拼写（特别是doxygen注释）？我正在寻找只会解析评论的内容，这样我就可以轻松找到错误并纠正错误。

问题是一般性的，但更具体一点 - 我正在使用CodeLite IDE。

Answer 1

Emacs的ispell-comments-and-strings在编辑器中运行良好。它依赖于语法突出显示机制来识别注释和字符串，因此它适用于您具有良好突出显示的任何语言。

不知道你是如何使用IDE的。

Answer 2

检查doxygen评论的好地方似乎是doxygen本身。但它没有检查拼写：？

快速，我认为可能有用的解决方法是生成LaTeX输出，然后使用LaTeX进行拼写检查。另一种解决方案可能是使用doxygen's Perl Module output format并在Perl中编写一些代码进行拼写检查（例如，使用Aspell或Ispell）。

使用IDE它更简单，因为任何体面的IDE都应支持对文档注释的拼写检查（Eclipse CDT就是一个例子）

Answer 3

我也需要这样的东西。它需要能够不仅在Linux上运行。

我已经看到拼写检查通常与IDE配对（比如eclipse）。我想要一个完全独立于任何IDE的工具，因为我希望能够在自动/脚本化的上下文中运行它，如Travis-CI构建或AppVeyor CI构建。

稍微考虑一下这样的工具，然后决定自己编写。

我想出的是满足这些需求的pyspellcode。它是一个使用clang和hunspell的python脚本，至少应该可以在Linux上运行。脚本：

1. 运行clang以获取其AST转储输出
2. 读取AST信息并找到注释节点
3. 将这些单词传递给hunspell进行检查，然后
4. 报告未被识别的字词。

令我感到惊讶的是，clang如何将C ++注释解析为doxygen元素和嵌入式HTML标记。这使得有可能使用clang的AST来执行诸如忽略嵌套在<code>...</code>块中的单词之类的事情，并且我在脚本中利用了这一点。

GitHub提供的脚本是Zlib许可的开源项目。它目前只是alpha软件中至少有一个解析错误，但如果它对它有兴趣，我会给它更优先。

希望这有帮助！