聲明一個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;