javascript - 如何使用 jsduck 记录 overrides 文件夹中的类

Question

使用以下架构，如何使用 jsduck 记录 overrides 文件夹中的类。

 MyApp
 -app
 -overrides
 -plugins
 -resources
 -...

似乎只能记录应用程序文件夹中的类。 在我的 jsduck 文档中仅显示文件夹“app”和“Ext”

以及如何创建指向文件夹覆盖内的文件的链接。以下选项不起作用:

{@link overrides.file file}
{@link MyApp.overrides.file file}

编辑:

MyApp
-app 
 . panel
   . panel.MyController.js
     . onPrintButtonMethod (overrides.printPanel.js)
-overrides
 . overrides.printPanel.js
-plugins
-resources
-...

我尝试了以下解决方案，但 jsduck 中似乎没有记录任何对“override.PrintPanel”类的引用。记录此案例的最佳方式是什么？

/**
*@class myapp.panel.MyController
*@class overrides.PrintPanel 
*
*@override myapp.panel.MyController
*@override Ext.panel.Panel
*/
Ext.define('overrides.PrintPanel', {
  override: 'Ext.panel.Panel',
  …
});

jsduck中显示的文件夹和文件:

- MyApp
  -app
   - store
   - ux
   - view
     - panel
       -panel.MyController.js
- Ext
  -Microloader
  global

Answer 1

看看@override tag docs .

关于源文件的@link，JSDuck 不支持这些。尽管实际上并不需要它们 - 记录的方法/类/等将自动链接到源文件。如果您确实需要，可以使用硬编码的 Markdown 或 HTML 链接。