JSDoc:适用于孙类的文档泛型类型



记录泛型类型适用于直接继承。但是当我有一个继承链时,没有办法让它为孙子班工作。下面是一个示例:

* @property {string} color
* @template {T}
*/
class MyColor {
constructor() {
this.color = 'unknown';
}
/**
* @returns {T}
*/
static makeColor() {
return /**@type {T}*/ new this.prototype.constructor();
}
}
/**
* @extends MyColor<Red>
* @template {T}
*/
class Red extends MyColor {
constructor() {
super();
this.color = 'red';
}
}
/**
* @extends Red<DarkRed>
*/
class DarkRed extends Red {
constructor() {
super();
this.level = 2;
}
darker() {
this.level += 1;
}
}
const circle = DarkRed.makeColor();

DarkRed.makeColor只承认返回为Red,而不承认DarkRed。有没有办法让它与@template一起工作?或者有没有其他方法可以使其工作?

我正在使用WebStorm作为IDE。

从 https://github.com/google/closure-compiler/wiki/Generic-Types#inheritance-of-generic-types 开始,@extends MyColor<Red>"修复"模板类型,而不是将其传播到继承类型。例如,在

/**
* @constructor
* @template T
*/
var A = function() { };
/** @param {T} t */
A.prototype.method = function(t) {  };
/**
* @constructor
* @extends {A<string>}
*/
var B = function() {  };
/**
* @constructor
*
* @extends {B<number>}
*/
var C = function() {  };

var cc =new C();
var bb = new B();
var bm = bb.method("hello");
var cm = cc.method(1);

cc.method(1)将导致TYPE_MISMATCH: actual parameter 1 of A.prototype.method does not match formal parameter found : number required: string

您可以尝试将代码更改为

/**
* @property {string} color
* @template {T}
*/
class MyColor {
constructor() {
this.color = 'unknown';
}
/**
* @returns {T}
*/
static makeColor() {
return /**@type {T}*/ new this.prototype.constructor();
}
}
/**
* @extends MyColor<T>
* @template {T}
*/
class Red extends MyColor {
constructor() {
super();
this.color = 'red';
}
}
const circle1 = Red.makeColor();
/**
* @extends Red<DarkRed>
*
*/
class DarkRed extends Red {
constructor() {
super();
this.level = 2;
}
darker() {
this.level += 1;
}
}
const circle = DarkRed.makeColor();

另一种可能的解决方案是使用@return {this}而不是@template(自 2018.2 起有效(:

class MyColor {
constructor() {
this.color = 'unknown';
}
/**
* @return {this}
*/
static makeColor() {
return  new this.prototype.constructor();
}
}

class Red extends MyColor {
constructor() {
super();
this.color = 'red';
}
}
class DarkRed extends Red {
constructor() {
super();
this.level = 2;
}
darker() {
this.level += 1;
}
}

最新更新