@doc注释的目的和从Rascal模块生成doc

时间:2014-11-04 14:16:30

标签: rascal

我通过Rascal模块找到了大量的@doc注释,但不知道它们是如何工作的。我试图创建javadoc,但不直接支持。我觉得必须有一种方法可以通过在Rascal项目中运行模块来生成一个文档集合。任何帮助表示赞赏...

2 个答案:

答案 0 :(得分:1)

没有好答案的好问题。 doc标签用于在http://tutor.rascal-mpl.org为标准库生成教师页面,并由类型检查器(待发布)用于在IDE中生成悬停帮助。目前,我们没有为您描述的任何项目制定流程。应该有!

答案 1 :(得分:1)

Tutor documentation中记录了@doc注释所需的信息格式。 该信息用于记录库函数。为了给您一个印象:Lists上有关Rascal函数的文档是从找到的here列表模块的源代码生成的。

相同的信息结构用于完整的Tutor页面。例如,文件Rascal.concept会生成Rascal教程的Main page

有一些洞穴:

  • @doc标记尚未在代码库中一致使用。
  • IDE中仍然缺少对@doc信息的悬停支持。