代码之家 › 专栏 › 技术社区 › Ryu

工具扫描代码注释,并转换为标准格式[关闭]

documentation-generation doxygen comments documentation c

3

Ryu · 技术社区 · 15 年前

我正在做一个C项目,这个项目有很多不同的作者和不同的文档样式。

我很喜欢 doxygen 以及其他文档生成工具,我希望迁移此项目以使用其中一个系统。

谢谢

3 回复 | 直到 14 年前

1

2

t0mm13b 15 年前

Lex + Yacc ,如果命令行上有输出注释的代码,则在第2章中有一节说明如何解析注释的代码,包括 // 和 /*..*/ progs.zip ,您要查找的文件是 ch2-09.l

如果你感兴趣的话,我可以在这里贴出怎么做的说明?

编辑: 我想我找到了你想要的东西,一个预先构建的注释文档提取器 here .

谨致问候, 汤姆。

2

1

Community CDub 8 年前

tommieb75 建议使用适当的解析器来处理这个问题。

我建议你看看 ANTLR The Definitive ANTLR reference .

3

1

Jason Williams 14 年前

如果要分析的样式集相对有限,那么编写一个Visual Studio宏(用于IDE)或一个独立的应用程序(仅用于脱机处理源代码)将相当简单,该应用程序将搜索文件中的注释,然后使用某些标题或标记将其重新格式化为新样式,以将它们分开。

一个可以帮助你的捷径是用我的 AtomineerUtils Pro Documentation 加载项。它可以一次找到并转换源文件中的所有注释。它可以立即解析XML文档、Doxygen、JavaDoc和Qt格式(或者任何与它们足够接近的格式),然后可以以任何这些格式输出注释。它还可以配置为转换不兼容的旧注释。有几种方法可以帮助转换,但是最强大的 calls a Visual Studio Macro

转换后的文本不需要特别整洁-一旦AtomineerUtils可以提取条目中的文档,它将为您清除注释-它可以选择自动应用换行、一致的元素顺序和间距等,并确保注释准确地描述了它记录的代码元素(其条目与params、typeparams、抛出的异常等),然后以其配置的格式输出替换注释。这节省了您在转换宏中的大量工作,以使事情整洁-转换完成后,您可以继续使用加载项来节省编写代码文档的时间,并确保所有新注释都以相同的样式继续。