@grom111

Как правильно комментировать код?

Всем привет.
Учусь писать документированный код.
Можете ли глянуть правильно ли я это делаю?

Код - https://codepen.io/Slasher_/pen/wpXxYG?editors=0010
  • Вопрос задан
  • 119 просмотров
Решения вопроса 2
@vith77
На случай, если еще не читали:

https://www.ozon.ru/context/detail/id/5011068/
https://www.ozon.ru/context/detail/id/138437220/

в обоих книгах есть главы про комментирование кода.
Ответ написан
@kulaeff
Front-end developer
А что такое *user info, *user data? В фигурных скобках нужно указывать тип переменной, например, string, number, object или какой-то свой кастомный тип, заданный с помощью `@typedef`. И обычно не пишут "Function for ...", и так понятно, что это функция, достаточно написать, например, Gets a random text message, Creates user message. Или то же самое, но в инфинитиве - Get, Create и т.д.
Ответ написан
Пригласить эксперта
Ваш ответ на вопрос

Войдите, чтобы написать ответ

Похожие вопросы