扫描代码注释的工具，并转换为标准格式 [英] Tool to Scan Code Comments, and convert to Standard Format

问题描述

我是一个大风扇的 doxygen 和其他文档生成工具，我想迁移此项目以使用这些系统之一。

有人知道一个工具可以扫描源代码注释的关键词，如说明，作者，文件名和其他种类的上下文智能转换注释为标准格式？

感谢

解决方案

当我阅读O'Reilly在 Lex + Yacc ，是有代码在命令行输出注释，第2章中有一节介绍如何解析注释的代码，包括 // 和 /*..*/ ...在页面上有一个链接的例子，下载文件 progs.zip ，您要查找的文件是 ch2-09.l ，需要要构建，可以轻松地修改以输出注释。然后可以在脚本中使用过滤掉'Name'，'Description'等...

我可以在这里发布说明如何做

我想我已经找到了你要找的，一个预构建的注释文档提取器此处。

希望有帮助，
，
Tom。

I'm working on a C project that has seen many different authors and many different documentation styles.

I'm a big fan of doxygen and other documentation generations tools, and I would like to migrate this project to use one of these systems.

Is anybody aware of a tool that can scan source code comments for keywords like "Description", "Author", "File Name" and other sorts of context to intelligently convert comments to a standard format? If not I suppose I could write a crazy script, or convert manually.

Thanks

解决方案

The only one I can think of when I read the O'Reilly's book on Lex + Yacc, was that there was code to output the comments on the command line, there was a section in chapter 2 that shows how to parse the code for comments including the // and /*..*/...There's a link on the page for examples, download the file progs.zip, the file you're looking for is ch2-09.l which needs to be built, it can be easily modified to output the comments. Then that can be used in a script to filter out 'Name', 'Description' etc...

I can post the instructions here on how to do this if you are interested?

Edit: I think I have found what you are looking for, a prebuilt comment documentation extractor here.

Hope this helps, Best regards, Tom.

这篇关于扫描代码注释的工具，并转换为标准格式的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！