Можно ли отобразить пользовательскую ошибку машинописного текста в VS-коде при неправильном использовании интерфейса?

Question

Я пытаюсь объяснить себе (в будущем, смеется), как именно должна быть реализована функция. Было бы неплохо, если бы я мог заставить пользовательский интерфейс сказать мне, что ИМЕННО мне нужно вернуть, а не то, что я не должен возвращение. Дано:

type ruleFunction = (this: Rule, dev: Developer) => 'submitResultsFunction'

const foo: ruleFunction = (dev: Developer) => {} 

в настоящее время показывает: «Тип» (this: Rule, dev: Developer => void не может быть назначен типу «ruleFunction»

Я хотел бы заменить этот текст с 'функция должна возвращать' submitResultsFunction '

Answer 1

Вы можете использовать обозначение jsdo c. Например,

type Fn = (arg: number) => string

/**
 * 
 * @description Function do something
 * @returns {string} Fn must return `sdf` string
 */
const myFunction: Fn = (arg) => 'sdf'

При наведении указателя мыши на myFunction вы увидите всплывающую подсказку кода VS.

Документация для jsdoc в машинописном тексте здесь