“必须”将预定义的@callback 签名分配给函数定义？

Question

如果我在 JSDoc 中使用 @callback 或在 .t.ds 库中使用 type 定义了函数签名，我可以使用 JSDoc 以某种方式将该签名“附加”到多个函数定义吗？

/**
 * @callback ruleDefiner
 * @param {RuleDefinitionBuilder} builder
 */

然后：

/** @thisFunctionIsA {ruleDefiner} */
function spellfix(builder) {

    // The IDE should know that builder is a RuleDefinitionBuilder
    const {depends, produces, cmd, T} = builder;

    const input = depends("foo.txt");
    const output = produces("foo.spellfixed.txt");
    cmd(T`spellfix ${input} > ${output}`);
}

/** @thisFunctionIsA {ruleDefiner} */
function sign(builder) {

    // The IDE should know that builder is a RuleDefinitionBuilder
    const {depends, produces, cmd, T} = builder;

    const input = depends("foo.spellfixed.txt");
    const output = produces("foo.signed.txt");
    cmd(T`sign ${input} > ${output}`);
}

我应该用什么来代替伪 JSDoc @thisFunctionIsA？

Answer 1

是的，你可以，使用 @type 标签。

/**
 * @callback ruleDefiner
 * @param {RuleDefinitionBuilder} builder
 */

/** @type {ruleDefiner} */
function spellfix(builder) {

    // The IDE should know that builder is a RuleDefinitionBuilder
    const {depends, produces, cmd, T} = builder;

    const input = depends("foo.txt");
    const output = produces("foo.spellfixed.txt");
    cmd(T`spellfix ${input} > ${output}`);
}

/** @type {ruleDefiner} */
function sign(builder) {

    // The IDE should know that builder is a RuleDefinitionBuilder
    const {depends, produces, cmd, T} = builder;

    const input = depends("foo.spellfixed.txt");
    const output = produces("foo.signed.txt");
    cmd(T`sign ${input} > ${output}`);
}

编辑： 如果这确实/严格适用于 JSDoc，请参阅this JSDoc documentation 了解更多信息。但是，如果您像我一样，只在编辑器中将 JSDoc 与 JavaScript 用于 IntelliSense，您可能需要 this TypeScript documentation（JavaScript IntelliSense 实际使用的）。