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

Question

是否有可能在一个类（AMD / RequireJS模块）中“分组”功能？我的类有时超过20多个函数实际上属于特定的“接口实现”，有时它们只需要进行分组以提高可读性。

我检查了可用的jsDoc标签但是它们似乎都没有提供这个，在Doxygen中有多少标签......

有什么想法吗？

Answer 1

这是一种方法，你的模块形状可能非常，但这适用于类和模块：

/**
* @module foobar
*
* @memberof module:foobar
* @param {string} arg an argument
**/
function one (arg) {
    console.log(arg)
}
module.exports = {
    one: one
}

关键是使用@memberof，documented here。

您可以将它与@class文档或@module文档一起使用，因此它可以与各种ES5，ES6或TypeScript类或模块形状一起使用，只要您记录容器对象（类或模块）， @class或@module。

结果：