jsdoc - 重用另一个命名空间中的文档

Question

我有一个命名空间，它将相同的函数分配给全局命名空间。 例如

/**
 * @namespace Main
 */
module.exports = {
  Sub: require('./sub')(module.exports),
  Sob: require('./sob')(module.exports)
  /* many other namespaces */
};

然后在里面，例如sub.js

/**
 * @namespace Main.Sub
 */
module.exports = function(mainExports){
  return {
    /**
     * @function Main.Sub.addStuff 
     * // all the rest of documentation in here
     */
    addStuff: mainExports.addStuff = function(){
    }
  };
};

我希望能够列出具有相同参数的相同函数以及 Main 命名空间上的所有内容。现在，我正在复制 doc block ，但将 @function 标记的名称更改为 @function Main.addStuff 并且它可以工作，但会导致很多代码中的噪音

Answer 1

目前，JSDoc 不提供继承另一个符号文档的方法。

对于 JSDoc 3.3.0(下一个主要版本)，我计划通过添加对 @inheritdoc 标记的支持来实现此功能。此功能被跟踪为 issue #53在 JSDoc 的 GitHub 存储库中。