如何识别与Java类/函数关联的注释?

时间:2014-11-25 16:29:21

标签: java regex eclipse documentation-generation

首先,我想澄清一点,我并不是在寻找有关现有文档生成器的建议。 我的家庭作业是建立一个文档生成器(如JavaDoc克隆)。

这是我迄今为止所做的事情:

我的第一个观察是,由于文档通常是在代码经过测试后编写的,因此可以安全地假设代码没有语法错误。 使用这个观察我创建了正则表达式来识别类和函数声明语句。从这些语句中我提取了正则表达式中的组以获取有关类/函数的详细信息(例如:名称,继承类,返回类型等)。

现在我在这里被困住了。我无法修改我的逻辑来提取注释并将其与为其编写的相应类/函数的描述相关联(为此我假设描述行为的注释写在类/函数的声明之上)

我试图找出一种方法来扩展我的程序逻辑以提取注释描述但是大多数开源工具如Doclava(https://code.google.com/p/doclava/)都非常复杂并且使用某种解析器而我不知道它们是什么或它们是如何工作的。

0 个答案:

没有答案