@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信息的懸停支持。