javascript - 将 CommonJs 模块声明为 mixin (JsDoc)

Question

我有多个独立模块，它们只是类使用的 mixin。

基本上，我的语法是这样的：

/** @mixin actions/actions */

var actions = module.exports;

/**
 * Some method
 */
actions.foo = function () {};

该文件被检测为 mixin，但在 API 描述中没有附加任何方法。

我正在使用 JsDoc 3.3 并且找不到为什么这不起作用。

Answer 1

我找到了一个适合我的解决方案。命名@mixin是问题，因为页面上无法识别该符号。如果需要，您需要做的是@alias（或保留变量名）。

/**
 * @mixin
 * @alias actions/actions
 */
var actions = module.exports;