声明一个CommonJs模块作为mixin（JsDoc）

Question

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

基本上，我的语法是正是这种：

/** @mixin actions/actions */ 

var actions = module.exports; 

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

的文件被检测为一个混合的，但没有一种方法被附接到它的API描述的内部。

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

Answer 1

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

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