2

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

4

2 回答 2

1

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

于 2014-11-04T16:30:22.080 回答
1

所需的注释信息格式@doc记录在Tutor 文档中。该信息用于记录，例如，库函数。给你一个印象：关于Lists上的 Rascal 函数的文档是从这里的 List 模块的源代码生成的。

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

有一些洞穴：

  • 这些@doc标签尚未在整个代码库中一致使用。
  • @docIDE 中仍然缺少对信息的悬停支持。
于 2014-11-05T11:28:46.973 回答