JSDoc生成的文档中的分组函数

Question

我将使用documentationjs（它在幕后使用jsdoc）来处理我正在开发的库的文档生成。我的库是用ES6编写的，是完全可用的，目前生成的文档是该库中所有模块的所有函数的按字母顺序排列列表。这使得查找您要查找的内容非常困难。我应该如何使用jsdoc注释，以便在文档中将一个文件中的函数分组在一起？

例如，给定以下文件...

/**
 * Docs for alpha
 */
export const alpha = () {};

/**
 * Docs for beta
 */
export const beta = ()  {};

/**
 * Docs for charlie
 */
export const charlie = () {};

如何使用jsdoc注释以确保三个函数在文档中被归为“Example”组？

我尝试在类顶部定义一个模块：/** @module Example */，但是虽然这在文档中生成了一个名为“Example”的项，但函数并没有在其下分组。

我尝试在各个函数的文档中添加@memberof Example，但这没有任何效果。

我知道this的问题，但它对我无效，可能是因为ES6导入。 文档中没有提到如何与@module一起使用。

- Undistraction

---

当我按照你所描述的尝试时，它完美地运行。也许我无意中纠正了你所犯的错误。你应该编辑你的问题，以显示你尝试过的内容。 - Louis

谢谢。你是使用documentationjs还是只用jsdoc？ - Undistraction

我直接使用jsdoc。 - Louis

你可能遇到了这个问题 https://github.com/documentationjs/documentation/issues/803 ？ - Tarun Lalwani

事实上，documentationjs似乎并没有使用jsdoc。它只是声明支持“jsdoc风格”的注释，但我看不到任何对jsdoc的依赖。在你描述的情况下，jsdoc运作得非常完美。documentationjs对我也有效，但只有当我添加@memberof Example时。 - Wicharek

Answer 1

看起来documentationjs在生成文档时不支持JSDoc样式的分组，但是可以使用稍微不同的语法来分组函数。由于documentationjs（具有讽刺意味的）文档质量较差，我是通过尝试和错误发现了这一点：

/** @module Example **/

/**
 * @memberof Example
 */
const alpha = () => {};

注意：@member 参数不需要 module: 前缀。

- Undistraction

Answer 2

也许您可以尝试这个解决方法，直到jsdoc实现分组。

如何在JSDOC中以“组”的形式显示Javascript方法？

- Felipe Valdes

Answer 3

我认为你需要这样使用@module：

/** @module myModule */

/** will be module:myModule~foo */
var foo = 1;

/** will be module:myModule.bar */
var bar = function() {};

如此处所述这里。

- Mohamed Chaawa