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命名空间中使用相同的参数和所有内容列出相同的函数。现在，我正在复制文档块，但是将@function标记的名称更改为@function Main.addStuff并且它可以正常工作，但会导致代码中出现很多噪音

Answer 1

目前，JSDoc没有提供继承其他符号文档的方法。

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

从其他命名空间重用文档

1 个答案: