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

2ekbmq32  于 2023-11-16  发布在  Linux
关注(0)|答案(4)|浏览(125)

你建议用什么软件来检查c/c++源代码中注解的拼写(特别是doxygen注解)?我正在寻找一种只解析注解的软件,这样我就可以很容易地找到错误并纠正它们。
这个问题是一般性的,但更具体地说-我使用的是CodeLite IDE。

2admgd59

2admgd591#

Emacs有ispell-comments-and-strings,它在编辑器内部工作得很好。它依赖于语法突出显示机制来识别注解和字符串,所以它适用于任何语言,你有很好的突出显示。
不知道你如何让它与你的IDE一起工作。

xzlaal3s

xzlaal3s2#

我也需要这样的东西,它不仅需要能够在Linux上运行。
我看到拼写检查通常与IDE(如Eclipse)配对,但我想要一个完全独立于任何IDE的工具,因为我希望能够在自动化/脚本化的环境中运行它,如Travis-CI构建或AppVeyor CI构建。
四处寻找这样一个工具,然后决定写我自己的。
我想到的是pyspellcode,它满足了这些需求。这是一个使用clanghunspell的Python脚本,至少应该可以在Linux上运行。脚本:
1.运行clang获取AST转储输出,
1.读取AST信息并找到注解节点,
1.将这些单词传递给hunspell进行检查,然后
1.报告未被识别的单词。
对我来说,一个有趣的惊喜是clang可以将C++注解解析成doxygen元素和嵌入的HTML标记。这使得使用clang的AST来做一些事情成为可能,比如忽略嵌套在<code>...</code>块中的单词,我在脚本中利用了这一点。
该脚本可以从GitHub上获得,是一个Zlib许可的开源项目。目前它只是一个alpha软件,至少有一个解析错误,但如果有人对它感兴趣,我会给予更高的优先级。
希望这对你有帮助!

bz4sfanl

bz4sfanl3#

一个检查doxygen评论的好地方似乎是doxygen本身。但它不检查拼写:?。
快速,我想到的解决方法可能会起作用,就是生成LaTeX输出,然后使用LaTeX进行拼写检查。另一种解决方案可能是使用doxygen's Perl Module output format并用Perl编写一些代码进行拼写检查(例如使用Aspell或Isell)。
使用IDE就简单多了,因为任何像样的IDE都应该支持文档注解的拼写检查(Eclipse CDT就是一个例子)

vc9ivgsu

vc9ivgsu4#

现在有一个很好的检查器,以typos的形式提供,它提供了几个集成(虽然不是CodeLite)。它是可配置的,并且足够健壮,可以满足我的需求,并且以一个自给自足的tarball提供。
它不限于C/C++或注解,但您可以传递它的正则表达式来限制搜索效果(通过extend-ignore-re配置键)。
该项目还提供了一个comparison table与类似的软件。

相关问题