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

【问题标题】：Grouping Functions In JSDoc Generated DocumentationJSDoc 生成文档中的分组函数
【发布时间】：2018-03-09 07:48:25
【问题描述】：

我正在使用documentationjs（在后台使用 jsdoc）来处理我正在处理的库的文档生成。我的 lib 是用 ES6 编写的，功能齐全，目前生成的文档是按字母顺序排列的 lib 中所有模块的所有函数的列表。这使得很难找到您要查找的内容。我应该如何使用 jsdoc cmets 以便在文档中将一个文件中的函数组合在一起？

例如，给定以下文件……

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

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

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

...我应该如何使用 jsdoc cmets 来确保三个函数在文档中的“示例”下组合在一起？

我尝试在类的顶部定义一个模块：/** @module Example */，但尽管这会在文档中生成一个名为“示例”的项目，但函数并未在其下方分组。

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

我知道this 的问题，但它对我不起作用，可能是因为 ES6 导入。在the docs 中没有提到它与@module 一起使用。

【问题讨论】：

当我按照您描述的尝试进行操作时，它可以完美运行。也许我在不知不觉中纠正你犯的错误。您应该编辑您的问题以准确显示您尝试过的内容。
谢谢。你是用documentationjs还是只用jsdoc？
我直接用jsdoc。
感谢。看起来这可能是documentationjs的问题
你可能正在点击这个github.com/documentationjs/documentation/issues/803？

标签： javascript comments jsdoc jsdoc3 documentationjs

【解决方案1】：

documentationjs 在其生成的文档中似乎不支持 JSDoc 样式分组，但是，可以使用稍微不同的语法对函数进行分组。由于documentationjs的（具有讽刺意味的）糟糕的文档，我通过反复试验发现了这一点：

/** @module Example **/

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

注意：@member 参数没有 module: 前缀。

【讨论】：

【解决方案2】：

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

How to display Javascript methods in a 'group' in JSDOC?

【讨论】：

【解决方案3】：

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

/** @module myModule */

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

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

如here所述。

【讨论】：