是否有可能在一个类(AMD/RequireJS模块)中对函数进行分组?我的类有时有超过20个函数,这些函数实际上属于一个特定的“接口实现”,有时它们只需要分组以提高可读性。我检查了可用的jsDoc标签,但似乎没有一个提供这个,在Doxygen中有许多标签...有什么想法吗
siv3szwd1#
这是一种方法,你的模块形状可能很大,但是这适用于类和模块:
/** * @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文档一起使用,因此它可以与任何种类的ES 5,ES6或TypeScript类或模块形状一起使用,只要您使用@class或@module记录容器对象(类或模块)。结果:x1c 0d1x
1条答案
按热度按时间siv3szwd1#
这是一种方法,你的模块形状可能很大,但是这适用于类和模块:
关键是使用@memberof,documented here。
您可以将它与@class文档或@module文档一起使用,因此它可以与任何种类的ES 5,ES6或TypeScript类或模块形状一起使用,只要您使用@class或@module记录容器对象(类或模块)。
结果:x1c 0d1x