Товарищи. нужно ваше мнение, делаю ТЗ, в нем написано, нужен

Question

Товарищи. нужно ваше мнение, делаю ТЗ, в нем написано, нужен

хорошо откоментированный код, но я как читал статью, где писали, что когда много комментариев, то такой код === говнокод, так вот, стоит писать комменты рядом с кодом? или лучше все хорошо рассказать в readme?

#frontend #javascript #programming #react.js #russian

0

22.08.2023

4 ответов

6 просмотров

Drosiel Wild

это уловка, если ты им не понравишься они просто скажут "мало/много комментариев вы не подходите", забей делай как делаешь всегда. неповезло чё

0

22.08.2023

Nikolai

В практически любом проекте с бл должна быть дока. Из доки можно понять, про что фича, контекст ее применения. Код должен быть написан так, чтобы при чтении не появлялись лишние вопросы "а что это и куда?". Конечно, сложные конструкции лучше сопровождать комментариями, а то через пару месяцев сам забудешь, что там было написано. Итого: - дока - структурированный и понятный код - немного приправить комментариями + неплохо использовать jsDoc или аналог, раскидывать линки в коде, чтобы с доки сразу можно было на нужную конструкцию попасть

0

22.08.2023

Dmitry Remezov

код сам по себе описание логики, зачастую код в 100 раз выразительнее и понятнее постных портянок readme - общая информация комменты в коде - пояснить неочевидное

0

22.08.2023

Sunrise · Accepted Answer

Sunrise

JsDoc, много комментариев плохо да. Должно быть SID, коротко , интуитивно понятно, описательно

0

22.08.2023

169 похожих чатов

Товарищи. нужно ваше мнение, делаю ТЗ, в нем написано, нужен

4 ответов

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