Javascript 如何在';集团';在JSDOC里?
是否有可能在类(AMD/RequireJS模块)中“分组”函数?我的类有时有超过20个函数,它们实际上属于特定的“接口实现”,有时它们只需要分组以提高可读性 我检查了可用的jsDoc标记,但似乎没有一个提供此功能,在Doxygen中有许多标记Javascript 如何在';集团';在JSDOC里?,javascript,jsdoc,Javascript,Jsdoc,是否有可能在类(AMD/RequireJS模块)中“分组”函数?我的类有时有超过20个函数,它们实际上属于特定的“接口实现”,有时它们只需要分组以提高可读性 我检查了可用的jsDoc标记,但似乎没有一个提供此功能,在Doxygen中有许多标记 有什么想法吗 这是一种方法,您的模块形状可能非常复杂,但这适用于类和模块: /** * @module foobar * * @memberof module:foobar * @param {string} arg an argument **/ fun
有什么想法吗 这是一种方法,您的模块形状可能非常复杂,但这适用于类和模块:
/**
* @module foobar
*
* @memberof module:foobar
* @param {string} arg an argument
**/
function one (arg) {
console.log(arg)
}
module.exports = {
one: one
}
关键是使用@memberof
您可以将它与@class documentation或@module documentation一起使用,因此它可以与任何种类的ES5、ES6或TypeScript类或模块形状一起使用,只要您使用@class或@module来记录容器对象(类或模块)
结果:
目前可接受的解决方案,但正在等待jsdoc中真正的分组功能;)