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

Question

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

Answer 1

好问题，没有一个很好的答案。 doc标记用于为标准库生成教师页面http://tutor.rascal-mpl.org，并由类型检查器（将发布）用于在IDE中生成悬停帮助。正如您所描述的那样，目前我们没有任何项目的流程。应该有！

Answer 2

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

相同的信息结构用于完整Tutor页面。例如，文件Rascal.concept导致这个Rascal教程的Main page。

有一些cavests：

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