如何解决JSDoc:使用来自不同模块的 ES6 类和 @type 标签
我对 JSDoc 比较陌生,遇到了一个我无法解决的问题。如果相关,我使用的是 VSCode 而不是使用 TypeScript,只是普通的 JS。
假设我有 2 个像这样的 ES6 模块:
frontdoor.js
/**
* @module frontdoor
*/
/**
* Class representing a Front Door
*/
export class FrontDoor {
// Class implementation
}
house.js
/**
* @module house
*/
import {FrontDoor} from './frontdoor.js';
/**
* Class representing a House
*/
export class House {
/**
* Constructs a new House object
* @constructor
*/
constructor() {
/**
* A FrontDoor instance
* @type {FrontDoor}
*/
this.frontDoor = new FrontDoor();
}
}
现在,虽然这在 House 的构造函数中将鼠标悬停在“frontDoor”上时有效(因为 VSCode 将正确的类型显示为“(property) House.frontDoor: FrontDoor”。但在结果中HTML 文档,“FrontDoor”未显示为指向 FrontDoor 类的链接。
我也试过像这样直接链接到模块...
/**
* A FrontDoor instance
* @type {module:frontdoor.FrontDoor}
*/
这显示了文档中的一个链接,但看起来有点乱,而且 VSCode 显示 '(property) House.frontDoor: any' 作为悬停时的类型。
我如何正确设置此链接,以便在悬停时显示正确的类型,并将“FrontDoor”显示为文档中带有链接的类型)?我花了几天时间在 SO 和更广泛的互联网上查看类似的问题,但到目前为止一无所获。
版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。