【发布时间】：2014-11-04 14:16:29
【问题描述】：
我通过 Rascal 模块找到了很多 @doc 注释，但不知道它们是如何工作的。我尝试创建 javadoc，但不直接支持。我觉得必须有一种方法可以通过通过 Rascal 项目中的模块运行进程来生成文档集合。任何帮助表示赞赏...
【问题讨论】：
标签： rascal
【发布时间】：2014-11-04 14:16:29
【问题描述】：
没有好的答案的好问题。 doc 标记用于在http://tutor.rascal-mpl.org 处为标准库生成导师页面，并由类型检查器（即将发布）用于在 IDE 中生成悬停帮助。目前我们没有您描述的任何项目的流程。应该有！
【讨论】：
@doc 注释所需的信息格式记录在Tutor documentation 中。
该信息用于记录，例如，库函数。给你一个印象：Lists 上有关 Rascal 函数的文档是从 here 找到的 List 模块的源代码生成的。
相同的信息结构用于完整的 Tutor 页面。例如，文件Rascal.concept 导致了 Rascal 教程的 Main page。
有一些洞穴：
-
@doc标记尚未在整个代码库中统一使用。 - IDE 中仍然缺少对
@doc信息的悬停支持。
【讨论】：