Простите, но не могу молчать, для меня тема комментариев в коде весьма острая)
Если вам нужно писать комменты - значит код стоит дорабатывать пока он не будет читаться без дополнительных пояснений. Комментарии, это захламление, так как он номинально полезный. Нужно следить за актуальностью соответствия реализации и комментария.
Указывать типы аргументов и возврата в jsdoc при использовании ts у меня вызывает только один вопрос - зачем?) Написать бесполезную строку, что переменная email это мыло пользователя? А description зачем там же? Сделайте функцию с соответствующими названием и ваш дескрипшн никто и никогда не прочитает. JSdoc считаю оправданным для более сложной информации вроде примеров использования или ссылок на доку.
Чтобы избавится от комментов и не потерять понятности, нужно соблюдать несколько правил:
Писать небольшие функции, которые делают только то, что сказано в названии
Соблюдать в каждой функции один уровень абстракции
Давать говорящие имена сущностям
Этого уже будет достаточно, что бы избавится от практически любого коммента
Простите, но не могу молчать, для меня тема комментариев в коде весьма острая)
Если вам нужно писать комменты - значит код стоит дорабатывать пока он не будет читаться без дополнительных пояснений. Комментарии, это захламление, так как он номинально полезный. Нужно следить за актуальностью соответствия реализации и комментария.
Указывать типы аргументов и возврата в jsdoc при использовании ts у меня вызывает только один вопрос - зачем?) Написать бесполезную строку, что переменная email это мыло пользователя? А description зачем там же? Сделайте функцию с соответствующими названием и ваш дескрипшн никто и никогда не прочитает. JSdoc считаю оправданным для более сложной информации вроде примеров использования или ссылок на доку.
Чтобы избавится от комментов и не потерять понятности, нужно соблюдать несколько правил:
Писать небольшие функции, которые делают только то, что сказано в названии
Соблюдать в каждой функции один уровень абстракции
Давать говорящие имена сущностям
Этого уже будет достаточно, что бы избавится от практически любого коммента