C语言 工具来扫描代码注解,并转换为标准格式[关闭]

66bbxpm5  于 2023-01-01  发布在  其他
关注(0)|答案(3)|浏览(225)

**已关闭。**此问题不符合Stack Overflow guidelines。当前不接受答案。

我们不允许问题寻求有关书籍、工具、软件库等的推荐。你可以编辑问题,以便可以使用事实和引用来回答问题。
5年前关闭。
Improve this question
我正在处理一个C项目,这个项目已经有了许多不同的作者和许多不同的文档风格。
我是doxygen和其他文档生成工具的忠实粉丝,我想迁移这个项目以使用这些系统之一。
有没有人知道有一种工具可以扫描源代码注解中的关键字,如“描述”,“作者”,“文件名”和其他类型的上下文,以智能地将注解转换为标准格式?如果没有,我想我可以写一个疯狂的脚本,或手动转换。
谢啦,谢啦

w1jd8yoj

w1jd8yoj1#

当我阅读O'Reilly关于Lex + Yacc的书时,我能想到的唯一一个例子是,在命令行中有输出注解的代码,第2章中有一节介绍了如何解析注解的代码,包括///*..*/ ...页面上有一个示例链接,下载文件progs.zip,您正在寻找的文件是ch2-09.l,需要构建,它可以很容易地修改输出的意见。然后可以在脚本中使用过滤出'名称','描述'等...
如果你感兴趣的话,我可以在这里发布如何操作的说明。

**编辑:**我想我已经找到了您要找的东西,一个预构建的注解文档提取器here

bvjxkvbb

bvjxkvbb2#

我认为正如tommieb 75所建议的,一个合适的解析器是处理这个问题的方法。
我建议看看ANTLR,因为它支持就地重写令牌缓冲区,我认为这将最大限度地减少你必须做的保留空白等-见The Definitive ANTLR reference的第9.7章。

cl25kdpy

cl25kdpy3#

如果要解析的样式集相对有限,则编写一个Visual Studio宏(用于IDE)或一个独立应用程序(仅用于“脱机”处理源代码)会相当简单,这些宏或应用程序将搜索文件中的注解,然后使用某些标题或标记将注解重新格式化为新样式,以将其拆分开。
一个可能对您有帮助的快捷方式是使用我的AtomineerUtils Pro Documentation加载项,它可以在一个过程中查找并转换源文件中的所有注解,它可以解析XML文档、Doxygen JavaDoc和Qt格式(或任何与它们足够接近的格式),然后可以以这些格式中的任何一种输出注解。它还可以配置为转换不兼容的遗留注解。有几个选项可以帮助转换,但功能最强大的选项是在解析注解文本之前使用注解文本调用VisualStudioMacro,从而允许您应用一些字符串处理,将旧注解转换为AtomineerUtils随后可以读取的格式(网站上提供了一个最常用的传统样式的示例宏,因此修改它以科普您的传统格式通常非常简单,只要它适合计算机解析即可)。
转换后的文本不需要特别整洁--一旦AtomineerUtils可以提取文档条目,它就会为您清理注解--它可以选择自动应用自动换行、一致的元素排序和间距等,并确保注解准确地描述它所记录的代码元素(它的条目与参数、类型参数抛出的异常等),然后以其配置格式输出替换注解。这节省了您在转换宏中做大量工作来整理东西-一旦您完成转换,您可以继续使用插件来节省编写代码的时间,并确保所有新注解都以相同的样式继续。

相关问题