如何解决JsDocs:如何在工厂函数中记录方法?
从工厂函数car
创建对象时,无法获得JsDoc文档显示在对象的car.drive()
方法(Car()
)上。这是在VSCode中。
工厂功能:
/**
* Creates car object
* @param {Sting} model name of
*
* @returns {Object} car object
*/
function Car(model) {
this.model = model;
/**
* Makes the car drive
* @param {String} speed speed of car
*/
this.drive = (speed) => {
console.log(`Car is moving at ${speed} miles per hour`);
};
return this;
}
当我将鼠标悬停在car.drive()
上时,它没有显示JSDocs。它仅显示Any
。
const car = Car({}); // JsDocs for Car show up here
car.drive() // JsDocs for the drive method don't show up here
如何在this.drive
中记录Car
,以便可以在car.drive()
上看到JSDocs?这可能吗?
解决方法
VS Code可以识别JavaScript文件中的JSDoc文档。
使它起作用的唯一缺失是Car
是构造函数而不是函数。如果要初始化Car
的新对象,将使用代码
var car = new Car({});
car.drive();
请参阅new运算符的文档。
版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。