JSDOC：接受基类的实例，并在“@type”标签中接受它的子类

Question

我有一个由子类扩展（valioratorRequired）的基类（验证器）。

然后，在另一个类中，我想拥有一个可能是基类类型的实例集合（验证器）或其任何后代（valifatorRequired）。

但是，当我尝试创建子类的实例并将其放置在该集合中（在formfield分配的表达式类型类型验证了验证wasteratorRequired是可分配到类型验证器：

我怀疑错误来自我没有定义@type 正确标记。

解决该检查的正确方法是什么？

formfield.js：

import { ValidatorRequired } from './ValidatorRequired';

export class FormField {
    /**
     * Field's current value.
     *
     * @type {number|string}
     */
    value;

    /**
     * A collection of validators that should be run each time the field is validated.
     *
     * @type {Object.<string, Validator>}
     */
    validators = {};

    constructor({ required }) {
        this.required = Boolean(required);

        // The part after the `=` operator is underlined with grey as a weak warning
        this.validators.validatorRequired = new ValidatorRequired({ formField: this });
    }
}

valivator.js：

export class Validator {
    /**
     * The field to validate.
     *
     * @type {FormField}
     */
    formField;

    /**
     * @param formField {FormField}
     */
    constructor({ formField }) {
        this.formField = formField;
    }

    /**
     * Validates a field.
     * Should be overridden by child classes.
     *
     * @returns {boolean}
     */
    validate() {
        return this.success();
    }

    /**
     * Ends validation with successful result.
     *
     * @returns {boolean}
     */
    success() {
        return true;
    }

    /**
     * Ends validation with an error.
     *
     * @returns {boolean}
     */
    error() {
        return false;
    }
}

validatorRequired.js：

import { Validator } from './Validator';

/**
 * A validator that checks for field's value to be non-empty when it is required.
 */
export class ValidatorRequired extends Validator {
    /**
     * Validates a field.
     *
     * @returns {boolean}
     */
    validate() {
        // If the field is not required, return success.
        if (!this.formField.required) {
            return this.success();
        }

        // If the value is not falsy, return success.
        if (this.formField.value) {
            return this.success();
        }

        // If all previous checks have failed, return error.
        return this.error();
    }
}

Answer 1

事实证明，该错误不在JSDOC中的@Type标签中，而不是PhpStorm如何处理该类别指定的类。

我的反应库在项目中的其他地方导入。 React具有定义的类验证器。 phpStorm意识到这一点，并认为我在JSDOC中指定的验证器是React中的验证器，而不是我自己的验证器。

当您尝试通过JSDOC注释 validators field（ ctrl + +单击课程，或单击课程，或将光标放在班级，然后按 ctrl + b ）。如果这样做，您将获得一个“选择声明”对话窗口，其中所有可能的声明都列出：

< img src =“ https://i.sstatic.net/2gciz.png” alt =“选择声明＆quort”对话窗口窗口>

因此，解决方案是使phpStorm想到valy> valiver> valiverator指定的是我自己的班级100％。 很容易地完成此操作。

通过明确导入验证器： formfield.js：

import { Validator } from './Validator';

此解决方案的较小的下降：您的base类（validator），可以 包含在捆绑包中，无论是否使用。但是，我认为这会产生可忽略的影响，因为：

1. 如果您使用的是基类的后代，那么您当然会在捆绑包中包含基类（类validatorRequired扩展了<代码>验证器）。
2. 如果您不使用任何记录@Type tag（class formfield）的后代，则可能是在类的后代中使用它们记录用法（FormField后代），或者您做错了什么。
3. 基类的大小可能太小了，无法对捆绑包产生巨大影响。