Javascript JS文档:将函数参数定义为类的实例
假设有一个函数具有参数Javascript JS文档:将函数参数定义为类的实例,javascript,jsdoc,Javascript,Jsdoc,假设有一个函数具有参数元素 /** * Function's description ... * * @param {*} element * Element description .... * * @returns {Boolean} * Result description .... */ function myFunction(element) { return true; } 参数元素必须是(自定义)类MySpecialButton的实例。 这样,if(
元素
/**
* Function's description ...
*
* @param {*} element
* Element description ....
*
* @returns {Boolean}
* Result description ....
*/
function myFunction(element) {
return true;
}
参数元素
必须是(自定义)类MySpecialButton
的实例。
这样,if(MySpecialButton的元素实例)
将返回true
class MySpecialButton{
constructor(){
}
// Methods ...
}
因此,我试图通过键入参数元素的类名来定义它
* @param {MySpecialButton} element
* Element description ....
但是当我在Visual Studio代码中键入函数时,帮助会显示any
myFunction(element: any): boolean
那么,如何将函数参数定义为javascript类的实例呢?
类MySpecialButton
和上述函数不是在同一个JS文件中定义的。首先导入类,然后您可以在JSDoc中引用它:
// MySpecialButton.js
module.exports = class MySpecialButton{
constructor(){
}
// Methods ...
}
及
如果MySpecialButton
在同一个文件中定义,则该类在不同的文件中定义,对我来说效果很好。
const MySpecialButton = require('./MySpecialButton');
/**
* Function's description ...
*
* @param {MySpecialButton} element
* Element description ....
*
* @returns {Boolean}
* Result description ....
*/
function myFunction(element) {
return true;
}