Когда я должен использовать JSDocs? - PullRequest
0 голосов
/ 03 апреля 2020

Я знаю, что для функций с export JSDocs очень полезны, но есть и другие случаи, когда я должен их использовать?

Пример, имеет ли смысл добавлять JSDocs для функций без export?

1 Ответ

1 голос
/ 03 апреля 2020

Я склонен использовать JSDocs в качестве временного промежутка, прежде чем переключаться на Typescript, чтобы обеспечить лучшую информацию о вводе типа для моей IDE. В противном случае просто используйте JSDocs, когда вам нужна дополнительная информация о том, над чем вы работаете, будь то атрибуция в случае использования чужого кода или лучшее описание, которое можно отобразить при наведении курсора на редактор.

...