jsdoc typedef с ограниченной областью действия - PullRequest
0 голосов
/ 03 декабря 2018

Фон

Я использую jsdoc в проекте с PhpStorm.Цель состоит в том, чтобы позволить IDE выполнять статическую проверку типов.

Я предполагаю, что разработчики IDE пытаются следовать и реализовывать соглашения и значения, выдвинутые самим проектом jsdoc.

Я такжеПредположим, что логика для jsdoc в PhpStorm такая же, как и в WebStorm.

В общем, типы, определенные с @typedef, применяются во всех файлах и областях проекта - по крайней мере, именно так это реализовано в PhpStorm.,Это заставляет глубокое пространство имен различать те типы, которые иногда могут раздражать.

Вопрос

В некоторых случаях я хочу объявить типы с @typedef, которые применяются только к определенному файлу.Есть ли синтаксис для этого в jsdoc?

Пример

Например, у меня есть набор файлов, каждый из которых определяет определенный граф d3, с определенным форматом / структурой для записей данных, поступающих из CSVfile.

В верхней части каждого файла я хочу поместить typedef для документирования свойств записи, характерной для этого графика.

Затем я хочу использовать этот typedef дляПараметры функции документа находятся ниже в файле.

...