regex - 自动文档 - 创建快速解析器的最佳方法

Question

我有一个最终用户需要编辑的大型脚本，因此它需要一些多余的注释。我为我的文件使用类似于此的布局

//********************
//
// FileName
//    This script contains:
//    - Function X - does something
//    - Function Y - does something else
//
//********************

//********************
// Function X
// does something (<< I'd only like to enter this part once)
//********************
// Code here...

//********************
// Function Y
// does something else
//********************
// Code here...

我想创建一个简单的解析器，将函数摘要复制/粘贴到文件头。我知道有几种工具可以帮助实现这一点，比如 ANTLR 甚至 RegEx，但最好的方法是什么？

Answer 1

鉴于您提到的两个选项，ANTLR 和 Regex，我建议使用 ANTLR。从长远来看，ANTLR 会更加灵活，我相信您应该能够更有效地使用它（它基于语法进行解析）。正则表达式方法将仅限于常规语言，除非您添加一些自定义逻辑等。

例如，我怀疑您将很难使用正则表达式识别块内的注释和块外的注释。CFG 应该能够很好地做出这样的区分。再说一次，如果您可以控制来源，您可以起草一些规范，说明哪些类型的评论出现在哪里......