Без описания функционала, без примеров использования :)
я сторонник того что не надо все покрывать комментариями. Если все в коде очевидно, типов хватит. Если ты делаешь какой-то костыль, лучше описать почему так сделано
я сторонник того что не надо все покрывать комментариями. Если все в коде очевидно, типов хватит. Если ты делаешь какой-то костыль, лучше описать почему так сделано
Комментарии пишут чаще для того, чтобы по ним можно было сделать справку и через нее искать необходимый функционал. Если кода много, то даже опытному разработчику сложно искать все в коде.
Комментарии пишут чаще для того, чтобы по ним можно было сделать справку и через нее искать необходимый функционал. Если кода много, то даже опытному разработчику сложно искать все в коде.
В современных иде можно прыгать по коду cmd + клик, тем более когда он покрыт типами А в случае с комментариями ты должен держать что “Ага Вася в том месте в комментарии указал где юзается” Я уже молчу о том, что комментарий просто может инвалидироваться
Объясню чуть подробнее. Допустим, мне надо написать фукнцию, которая гипотетически уже есть в коде. Если есть справка, то её можно найти по описанию, если справки нет, то придется гадать, как же её мог назвать другой разработчик.