Size: a a a

TypeScript — русскоговорящее сообщество

2020 March 10

SV

Sergey Vakhramov in TypeScript — русскоговорящее сообщество
Здравствуйте, товарищи. У меня есть вопрос по докам.

Мне не особо нужна генерация документации, я бы хотел навести порядок в коде. Нашёл два пакета typedoc и tsdoc.

Хотел спросить, нужны ли мне они вообще. Когда в вебшторме начинаешь писать /**, то при автокомплите генерятся только параметры. Мне нужно, чтобы у параметров ещё типы проставлялись, генерился return с типом и модификатор private/public. Как это реализовать?
источник

SV

Sergey Vakhramov in TypeScript — русскоговорящее сообщество
Я об этом)
источник

ИК

Игорь Кацуба in TypeScript — русскоговорящее сообщество
Sergey Vakhramov
Здравствуйте, товарищи. У меня есть вопрос по докам.

Мне не особо нужна генерация документации, я бы хотел навести порядок в коде. Нашёл два пакета typedoc и tsdoc.

Хотел спросить, нужны ли мне они вообще. Когда в вебшторме начинаешь писать /**, то при автокомплите генерятся только параметры. Мне нужно, чтобы у параметров ещё типы проставлялись, генерился return с типом и модификатор private/public. Как это реализовать?
а зачем? Ведь у параметров указывается тип в коде, тип return'а тоже есть в коде. Камент в стиле jsdoc нужен только для описания фактически
источник

SV

Sergey Vakhramov in TypeScript — русскоговорящее сообщество
А зачем вы вопросом на вопрос отвечаете?
источник

MS

Maxim Sosnov in TypeScript — русскоговорящее сообщество
Sergey Vakhramov
А зачем вы вопросом на вопрос отвечаете?
потому что непонятно зачем вы хотите дублировать информацию из типов в JSDoc и зачем вы вообще хотите генерировать доку - для кого и для каких целей
источник

SV

Sergey Vakhramov in TypeScript — русскоговорящее сообщество
Вопрос был о том, как по дефолту добавлять параметры return, private/public и всё такое.
источник

MS

Maxim Sosnov in TypeScript — русскоговорящее сообщество
мы вошли в цикл :)
а зачем, если это уже описано в типах?
источник

AK

Aleh Kashnikau in TypeScript — русскоговорящее сообщество
вопрос про то, как настроить комменты в вебшторме?
источник

Т

Тимофей 🛴 in TypeScript — русскоговорящее сообщество
Sergey Vakhramov
Вопрос был о том, как по дефолту добавлять параметры return, private/public и всё такое.
Прочитай пункт в доке typedoc doc comments и пиши как там написано
источник

SV

Sergey Vakhramov in TypeScript — русскоговорящее сообщество
Я знаю все эти параметры. Опять же, вопрос в том, как по дефолту при автокомплите выдавать заранее шаблон полнее, чем просто название параметров.
источник

SV

Sergey Vakhramov in TypeScript — русскоговорящее сообщество
Это возможно? Если да, то какой конфиг править?
источник

SV

Sergey Vakhramov in TypeScript — русскоговорящее сообщество
Только ли это для шторма? Мне нужно, чтобы ещё и работало для VSCode, например. Я думал, что есть какой-то пакет в npm, который это делает.
источник

AK

Aleh Kashnikau in TypeScript — русскоговорящее сообщество
ну все еще плохо понятно, чего вы хотите добиться. Если хотите, чтобы вебшторм/другой редактор автоматом комплитил jsdoc копируя туда инфу про типы из tsserver это одно, если хотите тулу типа prettier, которая бегает по всему коду и штампует дублирующие комменты с типами около объявлений это чуток другое. Если генерить хтмльки с типами и доками к ним это вообще третье
источник

AK

Aleh Kashnikau in TypeScript — русскоговорящее сообщество
ну и как выше справедливо замечают, ни в одном из вариантов, кроме разве что третьего, непонятно зачем это вам нужно
источник

🅸🅳

🅸🆅🅰️🅽 🅳🆁🆄🅷🅰️🅺 in TypeScript — русскоговорящее сообщество
Привет всем 😊
Вопрос: Почему я в конструктор не могу передать объект типа Category. Он же наслидуеться от Hierarchy.  По крайней мере так говорит phpstorm что так нельзя
источник

AK

Andrei Kurosh in TypeScript — русскоговорящее сообщество
🅸🆅🅰️🅽 🅳🆁🆄🅷🅰️🅺
Привет всем 😊
Вопрос: Почему я в конструктор не могу передать объект типа Category. Он же наслидуеться от Hierarchy.  По крайней мере так говорит phpstorm что так нельзя
Покажи как конструктор-то вызываешь. Возможно ты пытаешься передать один объект, а требуется массив
источник

U

Unknown in TypeScript — русскоговорящее сообщество
Andrei Kurosh
Покажи как конструктор-то вызываешь. Возможно ты пытаешься передать один объект, а требуется массив
+
источник

🅸🅳

🅸🆅🅰️🅽 🅳🆁🆄🅷🅰️🅺 in TypeScript — русскоговорящее сообщество
Andrei Kurosh
Покажи как конструктор-то вызываешь. Возможно ты пытаешься передать один объект, а требуется массив
А блин я понял в чем проблема была... Я писал что функция будет возвращать такое...
public getCurrentCategory ():Array<Category> 

а должно так
public getCurrentCategory ():Array<Hierarchy>
источник

AK

Andrei Kurosh in TypeScript — русскоговорящее сообщество
P.S. Почему везде Array<T> а не T[]?
источник

🅸🅳

🅸🆅🅰️🅽 🅳🆁🆄🅷🅰️🅺 in TypeScript — русскоговорящее сообщество
Andrei Kurosh
P.S. Почему везде Array<T> а не T[]?
А в чем разница?)
источник