在ESDoc函数/类与手册页之间创建链接,反之亦然

时间:2018-07-04 16:31:33

标签: javascript documentation-generation esdoc

我是ESDoc的新手,但是有多年JSDoc经验。

与JSDoc的 Tutorials 功能最接近的是ESDoc的 Manual 功能。它使您可以编写独立的降价文档,并将其合并到最终构建的文档中。

我有两个问题:

  1. 在函数或类的描述中,如何链接到手册中的某个部分?在JSDoc中,@ tutorial标记可以做到这一点,但是在ESDoc中却不存在,并且似乎没有等效的@manual标记。
  2. 在手册页中,如何链接回功能/类的文档?在JSDoc中,我可以使用@link标记,但这在ESDoc手册页中不起作用。

1 个答案:

答案 0 :(得分:0)

尝试根据文档here使用@see