[英]How to document parameter of class type extending another class with JSDoc?
[英]JSDoc 3 Document constructor/class parameter
如何记录作为参数传递的构造函数(函数)?
例:
/** @class */
function A() {}
/**
* @param {Function} aConstructor
*/
function createA(aClass) {
return new aClass();
}
如您所见,我可以指定它是一个函数。 但是,我无法指定该函数将创建哪个对象。 有没有办法记录这个?
谢谢。
Google及其闭包提出了{function(new:type)}作为类型描述。 我假设,可以使用这样的东西(我在AMD上使用它):
/** @param {function(new:ClassOrInterfaceName)} aClass */
您可以在此处找到更多信息: http : //google-styleguide.googlecode.com/svn/trunk/javascriptguide.xml#JavaScript_Types
我希望,我的答案可以帮助某人)
正如评论中所讨论的,我提交了一个请求,因为在我看来它并不支持该功能。 使用instanceof的方法,“Function”在表示构造函数的对象实例时最接近。 如上所述, @ constructs或@returns
可以帮助您指示输出,但不能指示参数输入。
声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.