Как правильно писать комментарии в коде? Хорошие и Плохие комментарии по Clean Code

День тому

Сегодня продолжение курса лекций по Clean Code, в этот раз поговорим о Хороших и Плохих комментариях.
Курс о котором упоминает Сергей: PYTHON - bit.ly/3f9jUqC
Курсы для новичков:
JAVA - bit.ly/3rrdwgO
JAVA Start - bit.ly/3f9jAIq
C# START - bit.ly/3fefKxz
C#/.NET - bit.ly/3vV45Kd
Инструментарий JAVA - bit.ly/3fivlMC
Automation QA (Java) - bit.ly/3rnJIBV
ANDROID - bit.ly/2Po1KGJ
FRONT-END - bit.ly/3roCfCi
WORDPRESS Developer - bit.ly/3w15DC7
SALESFORCE Developer - bit.ly/3tU7Bme
UI/UX дизайн - bit.ly/3co8ZaG
GAME DEVELOPMENT - bit.ly/3sptfy7
Обучение на проекте - bit.ly/31hqByP
Продвинутые курсы для состоявшихся девелоперов:
GRASP and GoF Design patterns - bit.ly/3daPLV6
Enterprise patterns - bit.ly/2QvCqPw
Другие услуги:
Пробное собеседование - bit.ly/3sjAkAm
Карьерная консультация - bit.ly/3fbBH0k
Сайт Foxminded: bit.ly/3sn8wLx
Foxminded в ФБ: / foxmindedco
FoxmindEd в Instagram: / foxminded.ua
Foxminded в VK: foxminded
Мой Telegram: t.me/nemchinskiyOnBusiness
Для деловых запросов: youtube@foxminded.com.ua
Тайминг:
00:00 - вступление Сергея Немчинского
00:18 - курс Python в Foxminded
01:35 - не делайте из комментариев макияжа
02:58 - самовыражайтесь в коде
04:05 - хорошие комментарии
04:32 - legal information
05:38 - пояснения к поведению
07:17 - пояснение намерений
07:32 - пояснение запутанной части кода
09:45 - предупреждение о последствиях
11:20 - TO DO
13:02 - Javadoc
14:29 - бормотание
15:29 - излишние комментарии
15:55 - вводящий в заблуждение
16:45 - комментарии из-под палки
18:02 - журнал изменений
19:39 - белый шум
20:10 - используйте метод или переменную вместо комментария
20:47 - маркеры кода
21:21 - комментарии о закрытии блока
23:23 - закоментаренный код
25:58 - HTML комментарии
26:27 - информация о системе в локальном комментарии
26:50 - слишком много информации
27:05 - непонятные комментарии
27:25 - Javadocs в не публичных методах
#nemchinskiy #ityoutubersru #чистыйкод

КОМЕНТАРІ: 261

@alexandertirik1929 3 роки тому

Не прочитав название до конца, уже решил, что Сергей Немчинский начал учить своих подписчиков писать комментарии к своим видео

@Code.bless_you 2 роки тому

Ваш, кстати, очень даже ничего😁

@aleksandrageev7960 2 роки тому

Видео описывает правильное комментирование кода, чтобы тот был читаем. Пишите «зачем мы это делаем», а не «что мы делаем». - вот вроде правильный коммент к видео

@qwert9313 Рік тому

@@aleksandrageev7960 это из серии капитан очевидность)

@rostislavtelitsin828 3 роки тому

Как все таки хорошо что вас по прежнему зовут Сергей Немчинский))). Я каждый раз с опаской открываю видео и боюсь услышать что вас зовут как то по другому

@user-sg4qj4iw6p 3 роки тому

Он еще говорил раньше ,что он с большим опытом :-)

@andyvoice 3 роки тому

теперь в конце видео) можно улучший эту фишку, теперь неожиданно посреди видео Сергей будет говорить свою фразу)

@iuriibrazhko3612 3 роки тому

Шутки шутками, а Немчинский не начал рассказ от Адама и Евы. Ваши опасения не безосновательны))

@user-vt1op4cq3x 3 роки тому

@@andyvoice Вопрос про комментирование в embedded: частенько имеется большой участок кода, где регистры периферии заполняются конфигурационными значениями, или проверяются флаги системных событий. При этом даже из названий применяемых define не всегда понятно - что именно здесь происходит. Получается такой код все же допускает сквозное комментирование?

@Mirumir321 2 роки тому

это еженедельный бессмысленный комментарий-фича)))

@alexanderlogunov5147 3 роки тому

У нас как-то был комментарий в коде: "А ключ от АПИ возьмите у Раджи". Раджи на проекте не было. "Take API key from Raji".

@SergeyNemchinskiy 3 роки тому

ахахаха

@Snow-ug6yc 3 роки тому

Индусы умеют шутить 😂😂😂😂😂

@tourettesdisorder2 3 роки тому

Зита и Гита любят жабу. Пытался я как то добиться хоть чего то от поддержки хьюлета паккарда, бесполезное дело

@ostvsvl7712 3 роки тому

может это раджа из ряда визирь, раджа, проджект менеджер?)

@infinitynoir5441 3 роки тому

Это пизнес конечно, ору)

@prakctoleb1974 3 роки тому

«Это цикл» лучший комментарий, что я когда то видел

@user-fest 3 роки тому

Спасибо! тема интересная и, в какой-то мере, универсальная для разных языков.

@user-fest 3 роки тому

@@universum9876 ага😂 Бонус+ коммент для продвижения)) да и для автора приятен фидбек

@SergeyNemchinskiy 3 роки тому

и он прав :) Спасибо!

@wiseinvestor350 3 роки тому

Сергей, спасибо за Ваш труд! Всё полезно, познавательно и практично👍 Жду новых выпусков! Успехов Вам!

@rostislavtelitsin828 3 роки тому

Очень интересно. Хотелось бы посмотреть маленькие наглядные примеры правильного кода

@user-ni6dd4bh9u 3 роки тому

Я бы послушал про "индусов" их код и особенности )))

@SergeyNemchinskiy 3 роки тому

А меня за это не забанят? :)

@sampleusername 3 роки тому

Кстати, работаю с индусам (вся команда из Индии), и они пишут так же, как и все. Не сказал бы, что их код чем-то отличается от остальных. В целом очень шарящие и позитивные ребята, короче :)

@olegkovalenko2797 3 роки тому

@@SergeyNemchinskiy Можна про умовних "індусів", тобто яких помилок програмісти (початківці і не дуже) найчастіше припускаються у своєму коді. З вашого досвіду, звичайно

@olegkovalenko2797 3 роки тому

@@SergeyNemchinskiy До речі, було б непогано в якості прикладу наводити скріни тих помилок, про які ви розповідаєте. Це, звичайно, в дусі "капітан очевидність", але, на мою думку, було б дуже наглядно і краще б запам’ятовувалося

@denyskorkh3189 3 роки тому

@@sampleusername по-разному бывает. У нас например на проекте были типичные стереотипные индусы) Советую поработать с ними, интересный экспириенс)

@burningass5516 3 роки тому

Тема интересная, Сергей. Продолжайте, пожалуйста. Сам студент и смотрю с удовольствием.

@0imax 3 роки тому

Привычку к написанию капитанских комментариев часто формируют в учебных заведениях, заставляя студентов комментировать чуть ли не каждый шаг. Ох как меня это бесило. Сколько я срался с преподом из-за этого... - Зачем комментировать очевидные вещи? - Это для тебя они очевидные, а для других - нет!

@MaceUA 3 роки тому

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

@0imax 3 роки тому

int AAAAAAAAAAAAAAA; //Angel Of Death!

@0imax 3 роки тому

@@alexlightweight Вот не зря Сергей так топит за обучение с ментором: без критики от профессионала из отрасли легко уйти не туда (а то и вовсе не дойти). ИМХО, разработка хотя бы вдвоём по качеству кода, скорее всего, будет на голову выше разработки в одно лицо. А одному можно сидеть хоть 10 лет и не вырасти вообще.

@0imax 3 роки тому

@@alexlightweight Мне почему-то кажется, что если код настолько корявый, то и комменты были бы не сильно понятнее)) Но лучше, конечно, хоть какое-то объяснение, чем никакого.

@MaceUA 3 роки тому

@@alexlightweight У меня на самой первой работе была похожая ситуация. Ушёл оттуда, ибо было тяжело как мне с этими людьми, так и им со мной (я хоть и был без опыта, но теоретически уже понимал такого рода вещи). Они были намного старше, учились программировать где-то в восьмидесятые или начале девяностых, когда о хороших практиках программирования вообще мало кто слышал. И сейчас их уже не переучишь. Да и им это не интересно: для них-то всё работает, заказчик деньги платит, значит имеют право говнокодить как хотят (ну а я, соответственно, имею право поискать другое место работы, где взгляды программистов будут больше совпадать с моими).

@user-fu4pr5kx4u 3 роки тому

Этот курс лекций очень интересен! Сергей продолжай :)

@oleksandrorlenko1955 3 роки тому

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

@sampleusername 3 роки тому

Единственный канал, где я не проматываю рекламу)

@SergeyNemchinskiy 3 роки тому

очень приятно :)

@timbulaaras1986 3 роки тому

Кстати, да. Согласен)))

@illyamosiichuk670 3 роки тому

И... Это точно)

@sergiit9003 3 роки тому

@user-bd4lw9hx3s 2 роки тому

Очень интересная тема! Жутко полезно, давно хотел найти развернутое пособие "Что такое хорошо, а что такое плохое" по комментариям. Сергей, так держать!

@user-iz1jd5wf2e 3 роки тому

Очень хороший и нужный курс!!! Спасибо!!!

@user-ky2zi4fp9r 3 роки тому

Очень нужная серия лекций по клин код, спасибо!

@Leda-xh8ox 3 роки тому

Спасибо! Ещё хотелось бы именно от Вас о CI/CD услышать )

@MrGhast 2 роки тому

Огромное спасибо, Сергей, за полезный ролик!

@FixedA 3 роки тому

// Супер интересный курс, надеюсь по данной теме ролики еще будут.

@user-gx1vl3kx2u 3 роки тому

Спасибо за лекции!

@allamoisieieva1532 8 місяців тому

спасибо! интересно, а главное по существу и с примерами из практики )

@IPWchild 3 роки тому

Когда нужно решить задачу в очень сжатый срок - приходится писать говно, и оставлять для себя на будущее комментарии - что и как потом переделать. Так что без TO DO вообще никуда

@olegserikov6821 3 роки тому

Хоть и смотрел ещё давно фулл лекцию по мытью кота, но эта серия - пушка, спасибо, продолжайте!

@maxlich9139 3 роки тому

фулл с Немчинским))) звучит-то как)))

@edgull_tlt 2 роки тому

Спасибище огромное!

@user-sq7um9kh2o 3 роки тому

21:21 В языках с препроцессором (C/C++ и некоторые другие) комментарий о закрытии препроцессорного блока #if/#ifdef может выручать, если размер такого блока изрядный, или есть приличная вложенность подобных блоков. Просто облегчает поиск его окончания. Причём полезно дублировать в комментарии всю конструкцию изначального условия. #if SOME_DEFINE || OTHER_DEFINE > 0 ... 100500 строк. #ifdef DEBUG ... #endif // #ifdef DEBUG ... #else // #if SOME_DEFINE || OTHER_DEFINE > 0 ... 500100 строк. #endif // #if SOME_DEFINE || OTHER_DEFINE > 0 Обоснование: препроцессор это как бы "надязык", его конструкции переплетаются с кодом основной структуры программы, и зачастую не имеет отступов (так как это уменьшает наглядность кода или же такие отступы вступают в конфликт с отступами самого языка).

@0imax 3 роки тому

Qt автоматом добавляет такой коммент к концу Header guard-а для новых файлов. А для визуализации вложенности они у себя в коде отделяют пробелами # и команду препроцессору: #ifndef FOO # ifndef BAR # define BAR # endif #endif Но всё-равно препроцессор - это адский ад, сильно замусоривает код.

@max_mgtow 3 роки тому

Спасибо, наш дорогой Сергей Немчинский 😄

@denwerxampp4035 3 роки тому

Всё интересно. С удовольствием послушал бы о профилировании приложений java

@BorisAverin 2 роки тому

Для тех кто в теме просто огонь)))

@user-rw3pl5sy4x 2 роки тому

Отличное видео! Хоть оно и предназначается для новичков, но у меня частенько возникает желание отправить его некоторым из своих коллег))

@Zohan136 Рік тому

thanks so much 😀

@user-gj8tw9mw3l Рік тому

Спасибо Эйр Астану. Я рад.

@aidarnigmatullin3512 3 роки тому

Доброго дня. Классный цикл лекций. Для прошареных наверно известные истины, для остальных же, хорошая подача. Интересно про взаимодействие в команде. Например фронт/бэк. Как разговаривать если ты делаешь систему, которая зависит от другой системы.

@user-vo9pg4ff5q Рік тому

SFsdsrsd

@vitalijuskolinko9011 3 роки тому

Очень полезная информация! Спасибо! Было бы здорово после всех серий показать рабочий пример со всеми затронутыми темами и выложить его на git как шпаргалку ;)

@Sergey.Aleksandrovich.P-37rus 3 роки тому

про Патрика Свейзи... улыбнуло)

@nekad 3 роки тому

Сергей, спасибо за очередную полезную лекцию! Было бы по очень интересно послушать про хорошие и плохие коммиты. А то когда начинаю работать делаю коммит под каждый чих, а потом вхожу в раш, забываю про комиты. И в конце дня у меня 5 коммитов по 2 строки кода каждый и 1 последний на ~200 строк)))

@vitaliidrapaliuk5652 2 роки тому

і про назви комітів

@oleggrudko8137 3 роки тому

отличное видео, правил комменты к своим автотестам прямо по ходу видео :)

@SergeyNemchinskiy 3 роки тому

отлично :)

@user-bf5zv3lo5s 2 роки тому

Раньше смотрел WOT блоггеров, сейчас это. Прям в другие места мозга нажимает. Полезные видео.

@thomas_man 3 роки тому

Золотое правило писания комментарии, просто и эффективно

@maxlich9139 3 роки тому

Ещё бы было интересно послушать про хорошие и плохие сообщения к коммитам в гите

@user-ki8mz4kj8q 3 роки тому

/** Хорошее видео */

@Az1zdev 3 роки тому

good video

@user-to2iu2rx6f 3 роки тому

Доброго дня, Сергей! Спасибо большое за ваши видео, они замечательны и полезны. Что касается чистоты кода, я думаю, многие согласятся с тем, что чем больше ваших видео выходит по этой теме, тем лучше. Поэтому продолжайте, пожалуйста, в том же духе, расскажите и объясните (у вас это здорово получается) все, что знаете. Большое спасибо за все видео на канале, это сверхполезно как для начинающих, так и для опытных специалистов в программировании. С нетерпеньем ждем новых видео!

@multar5630 2 роки тому

Я так курсач писал. "Нужно много коментов" говорили они, "прибавление единицы" писал я

@FilLost 3 роки тому

интересует послушать опыт о 1. разбиение на отдельные модули 2. про разделение на слои абстракций

@valerautukin5854 3 роки тому

Здравствуйте Сергей! Смотрю вас где-то с полгода. Хорошая и понятная подача, спасибо за контент! Нет ли у вас идеи, после цикла видосов по "Чистый код" сделать цикл по паттернам?

@valerautukin5854 3 роки тому

@@universum9876 Извиняюсь за свой русский)

@vitalijuskolinko9011 3 роки тому

Есть уже такое от Сергея - целая серия SOLID и других паттернов

@SergeyNemchinskiy 3 роки тому

у меня есть тренинг по паттернам: foxminded.com.ua/grasp-gof-design-patterns-advanced-on-line-course/

@MrAbad202 3 роки тому

У него ещё есть плейлист, с записями лекций, по паттернам, звук очень плохой, но содержание полезное

@sezam-zz6lf Рік тому

Для закоментированного кода есть специфический кейс. Когда просят вырубить фичу. Меняется программист. Просят врубить фичу. С ненулевой вероятностью новый программер напишет ее заново, если она не закоментарена, а удалена.

@Victor555777 2 роки тому

Один из самых шикарных моих комментариев - когда один объект перекладывали в другой и вместо номера документа клали текущую дату. Я прямо специально написал - "Нет, это не ошибка, здесь действительно надо менять номер документа на текущую дату, согласно письму ФНС номер такой-то". Чтобы при рефакторинге никто этот кусочек не выпилил со словами - "а чего это они тут навертели".

@agentsmit09 3 роки тому

Оказывается я правильные комменты в коде пишу. По поводу комментария "Это мост". Часто видел у новичков коммент типа "Цикл for начало/конец". Блин я и без коммента понимаю что это while :). Про закомментированный кусок кода, раньше оставлял, авось пригодится, реально ни разу не нужен если ты его заменил на другой работающий код.

@0imax 3 роки тому

Нас, когда мы были студентами, заставляли комментировать языковые конструкции, типа for(...)//цикл от.. до.. А выделение начала-конца блока я и сам, будучи совсем зелёным, делал, ибо тогда ИДЕшки не умели в нормальную подсветку (кто помнит Delphi - привет).

@agentsmit09 3 роки тому

@@0imax Нас при обучении, ни кто не заставлял комментировать вообще. Все комменты на свое усмотрение. Вот обучение было веселое: 1 курс - QBasic, 2- Turbo Pascal, 3 - Borland C++, 4 - Были разные предметы на которых каждый препод свой язык толкал и получилось что параллельно преподавались (Delphi, Visual Basic, Visual C++ MFC), 5 - только Visual Basic, хотя препод и не против если на C# или Java все сдашь.

@agentsmit09 3 роки тому

Ладно. Тут понятно откуда ноги растут. Но не понятно от куда такие же ноги у тех кто сам пытается научиться программированию. Но сомневаюсь, что везде так преподают.

@PaZ1tiFF 3 роки тому

CheckOplata - лучший комментарий из тех, что видел

@SergeyNemchinskiy 3 роки тому

ахаха

@user-pv3hz3bw1g 3 роки тому

Англо-український суржик латинкою!!!!! Аааааааааа

@maxlich9139 3 роки тому

комментарий? больше похоже на название класса (если говорить про джаву)

@alexeymurnikov1413 3 роки тому

У меня коллега любит так методы и классы называть, пока никто не видит. А ты потом думай, что значит MessagePresenterTut. Что за Tut, нахера оно нужно и не скрывается ли за ним какой-то сакральный бизнес-смысл?

@maxlich9139 3 роки тому

@@alexeymurnikov1413 Tut? Мейби сокращение как Dto🤷‍♂️

@max_mgtow 3 роки тому

Был как-то коментарий //какая же е..тая CMS как же от неё >|

@user-ko9hy3kn7e 3 роки тому

Нужная информация.

@alexein6631 3 роки тому

я не понимаю холивара вокруг комментов. Почему вдруг это стало такой обсуждаемой на каждом углу проблемой? Ну хороший код и не нужны комменты - красота, а если комменты есть - еще лучше. Я даже в собственном коде, который хорошо понимаю - оставляю комменты в первую очередь для себя, потому что мне проще врубиться в какие-нибудь алгоритмы фильтрации массивов, ключей и прочих циклов и шаманства, прочитав комменты, чем каждую строчку кода разбирать и пытаться вспомнить почему именно так делается и почему на входе получается один массив, а на выходе другой. За-то когда читаю чужой код с такой же магией - матерей разрабов в кино вожу, потому что им было лень написать 3 слова к своей конструкции и я должен тратить порой по нескольку часов, чтобы отдебажить каждую строчку кода и понять где собака зарыта. Просто есть шаблонный код, который ничего особого не выполняет и ты одним взглядом понимаешь что он выполняет, а бывают сложные алгоритмы, которые не с первого взгляда очевидны что они выполняют, как ты не упрощай код и как не называй ты те переменные, почему бы не оставить пару слов о том что выполняется в коде ниже. Я бывает в особых случаях даже каждую строчку комментирую в цикле, потому что было не раз такое, что возвращался к своему же коду, видел "ошибку" или какое-то "ненужное условие", удалял его, а потом ловил багулину, потому что оказывается оно там нужно было. После пары таких раз - решил класть на все эти ваши стандарты по клинкоду и писать так, чтобы любой индус разобрался. Особенно это актуально на старых и загаженных проектах, где все держится на подпорках из говна и палок. Это может на ваших там ААА проектах все чики-пуки, по всем современным стандартам в лице фреймворков, мне к сожалению такие видеть не доводилось.

@maxlich9139 3 роки тому

У меня на одном проекте в коде был комментарий: "Аня, удали этот ужас"))) Но сам я тоже этот ужас не удалил)) Так и живет наверно там))))

@user-yn2fk2gk3l 3 роки тому

Спасибо большое за выпуски) Я хотел поинтересоваться, как можно научиться быстрее читать и понимать чужой код? (Не нашёл такой выпуск, если такой выпуск есть, тыкните пожалуйста ссылкой)

@Sergey.Aleksandrovich.P-37rus 2 роки тому

Неоднократно включаю видео, играет на фоне, и допиливаю проект в IDE)

@AndrewAndZz 3 роки тому

По code smells было бы тоже интересно послушать

@SergeyNemchinskiy 3 роки тому

тема. Спасибо за совет

@Alex-gn6xb 3 роки тому

тема супер! поменьше о высоком, побольше о нужном - идеально.

@shmaltorhbooks 2 роки тому

серьёзно? понимание когда нужны или не нужны комменты - это что-то нужное?

@rodiond9903 3 роки тому

Сергей, добрый день! Какой минимум должен знать java-разработчик на первой работе в области CI/CD (например, про Docker, Openshift, Nexus, Jenkins, Checkmarx и Andible и др.)?

@oleksandrkovtunov487 Рік тому

Что касается журнала изменений, я обычно его полностью вижу через гит, прям в Идееке

@NewUser78654 3 роки тому

Как правильно писать комментарии в коде? В одной компании говорят пиши "так", в другой пиши "не так". Справа советуют - 30% (цифру придумайте сами) от общего кода. Слева злой амбициозный тимлид говорит - ноу комментс, тру профи всё и так поймет за секунды (были и такие самодуры). Немчинский дает советы - хорошие по делу, много советов. И другие программисты дают советы... Как уже говорилось, есть IDE которые скрывают определенные комментарии. legal и прочие блоки-регионы (VS). Осталось добавить опцию - не показывать комментарии. Вот вообще. И все будут счастливы. Хочешь - смотри, не хочешь - скрой и смотри чистый код. Всё для тебя. (И тут Остапа понесло...) Но так ведь нельзя верно? А вдруг? А вдруг там написано что то важное в комментарии, а в другом нет? А давайте введем уровни комментариев! Уровень вывода ошибок и его настройка (как в PHP) есть. Так и с комментариями сделаем. Маркируй важный коммент одним способом, а не важный другим. Ну тогда и систему маркировки сделаем. Когда и что маркировать. Книжку напишем. Ролики снимем. Пару систем комментариев придумаем. А может и паттернов? И будем долго спорить чья система лучше. А программа - да и фиг с ней. У нас тут комментарии, паттерны, ООП, гит, солид, тимлид, джун, фреймворки всякие, дженкинс, тесты, докер, девопс (полусисадмин, полупрограмист, полутестировщик на полузарплате?), скрум, джира в которой дедлайн. А программа - да и фиг с ней. Не мешайте нам играть в IT. Не до программы.

@user-mr8nr6qr5d 3 роки тому

Здравствуйте, расскажите пожалуйста,как узнать какие лучше функции использовать для программирования на c#, например делать кортеж или просто разбить на малые части , как вообще узнать какие функции больше грузят процессор? Можно ли где то прочитать информацию по этому поводу?

@igorgv5213 3 роки тому

Сергей, скажите ваше мнение о IBM i (AS400) и RPG. Правда ли умерают или будут жить долго, просто не популярны?

@linuxoidovich Рік тому

Теперь я знаю как написать чтобы мой код не трогали. Хотя смысла 0, но знаю.

@neverov-alex 3 роки тому

Sergey Nemchinskiy, добрый вечер. С чего начать самообучение на практике, Apache или Nginx ??? Обзавелся VPS хостингом и потихоньку изучаю linux что бы суметь разместить первое веб приложение на Java своими руками. В интернете про выбор того или иного, много разного пишут, что только усложняет выбор.

@tourettesdisorder2 3 роки тому

Забей на апач, вот что сделай на практике

@liravesnovaya242 3 роки тому

Комментарии "что внутри" в легаси с Active Record, где к этой базе, кроме твоего проекта ходят еще 10, это единственное спасение. На одном проекте в таблице были поля reason_cancel и cancel_reason: одно тип причины отказа (число), а второе - детальное описание. Спустя 10 проходов мимо этиэ двух полей пришлось всунуть комментарии к phpdoc-у с описанием этих полей.

@RadexStonder Рік тому

Закомментированый код - офигенная штука, когда ты - веб дев, сидишь на одном проекте годами и тебя периодически просят воткнуть на морде какой-то временный функционал. Или временно отключить какой-то функционал.

@shaaarkfromikea7546 3 роки тому

Назрел вопрос: часто проект на который ты приходишь, мягко говоря, не свежий. Например на Java 7 и переход на Java 8 только в планах и непонятно когда. Как лучше работать с плохо написанным спагетти легаси кодом? Спасибо за контент!)

@AntiVassal 2 роки тому

У меня был случай, когда после удаления одного комментария программа переставала компилироваться. Но там любые изменения (даже правильные с точки зрения синтаксиса языка) приводили к такому результату.

@septembercult985 3 роки тому

Принято ли большие классы размечать комментариями на блоки? Эта группа методов отвечает за интерфейс (образно), эта группа методов отвечает за взаимодействие с какими-нить API, эти что-то еще делают. Очень удобно, когда скроллишь большой класс вверх-вниз. IDE позволяют быстро найти искомый метод, но все же.

@typahastler8547 3 роки тому

Я качу послушать про .net, желательно с сопоставлением технологий, конкретно спринга (релаизации di контейнеров например), где что удобнее, лучше и т.д. Насколько я знаю в .net отсутствуют аннотации, там нет аналога Autowired и прочих удобных аннотаций, которые сильно упрощают написание кода. Хотелось бы услышать ваше мнение касательно этого

@Tumanop 3 роки тому

О том как коментить не кто не где не учат, очень полезное видео, об смысловой нагрузке комментариев даже не задумывался. Спасибо))

@RomanKuzmenko 3 роки тому

Самый полезный комментарии в коде: Никто не знает почему оно не работает, но если удалить - не работает)))

@xxxbunx 2 роки тому

like за python

@ostvsvl7712 3 роки тому

9:54 предупреждение о последствиях: если кто-то сломает этот код, придет пм и сломает кодеру пальцы))

@maxlich9139 3 роки тому

баш на баш_))))))

@user-cv6ok3yl4z 3 роки тому

Здравствуйте, расскажите про Code Style.

@user-mi4qz2ng4y 3 роки тому

1:35 несколько комментариев по поводу комментариев

@eugenstakhursky9604 3 роки тому

23:23 - эх, наверное многие грешили этим делом, не тысячи строк конечно, но всё же...

@0imax 3 роки тому

Приходилось ковыряться в прошивке на ассемблере, где из 8000 строк кода в общей сложности около 2000 были закомменчены. Асм и так не самый легко читаемый язык, а тут ещё и такое.

@javavlogger9409 3 роки тому

Что вы думаете про процесс программирования с псевдокодом?

@soul-snatcher225 Рік тому

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

@ShadeAlina 3 роки тому

Работала как-то на проекте, где были "высокие стандарты кода и комментирования", но всё время не оставляло ощущение, что гребу лопатой кучу удобрений. Вопросы отпали, когда наткнулась на комментарий: // ToDo удалить ..., когда ... /* блок кода */

@SpaSergo Рік тому

Хотел оставить комментарий, но понял, что он будет из разряда нежелательных ... ☺️

@andrewthebladethrower8371 Рік тому

а в несовременной идэешке мне иногда реально надо, для себя, хотя бы на время отладки, пояснить чей это конец ( энд; ). Тут никакого рефакторинга нет и ничё не уедет. И не схлопывается, т.к. это простенький турбо паскаль, а не какойнибудь лазарус. Точно не как в дотнете.

@vatakiller 3 роки тому

Про комментарии есть целая глава в книге Роберта Мартина - Чистый код

@user-wk5fm5qw1f 3 роки тому

так это серия видео как раз по этой книге (в начале вроде даже говорилось)

@gromfer708 3 роки тому

Негативно отношусь к PHPDoc т.к. методы становятся длиннее в два раза почти, а по факту к описанию метода через IDE я обращаюсь крайне редко...

@dmitriy9232 3 роки тому

я бывало оставлял комменты матом, ну если сильно пригорает )) иногда в комментах оставлял послания для потомков, шоб сильно не ругали ))

@kozakhookah 3 роки тому

В процесе обучения приучил себя присать коменты везде и всегда, недавно попал на первую работу(джава) и мне запретили писать коментирии в коде, абсолютно. Аргументируют тем что коментарии всеравно теряются в процесе потдержки и тем что написание коментов розхолаживает ( между сделать код понятнее и просто написать комент все выберают написать комент). Как вам такой подход ??

@user-lh6ou6de6l 3 роки тому

Ого, реклама питона))

@user-qh2ru8wk4t 3 роки тому

есть ещё один вид плохих комментариев: пустой todo - нужно что-то сделать, но что и зачем - не указано 🙃

@bogdanchirukin1050 3 роки тому

прослушал все видосы по клин-код и понял, что подтираю говнокод говнокодом(разрабатываю под вордпресс)

@SergeyNemchinskiy 3 роки тому

это нормально :)

@maxlich9139 3 роки тому

это называется "клин клином вышибать")))

@marlett1042 Рік тому

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

@dmitriimolchanov4971 3 роки тому

по поводу javadoc. По мне он не нужен и для многих public методов. Если методы используются той же частью системы, где находятся классы, где определены эти методы - по мне это тоже лишнее. javadoc нужен или для интерфейсов, которые будут использоваться в другой системе(javadoc для вашего API) или для методов, которые предосталвяют интерфейс другим частям вашей системы.

@vitamin2845 3 роки тому

Здравствуйте, Сергей. Как относитесь к "синьерам", которые сидят 10 лет на одном проекте?

@BaJIePkA86 3 роки тому

Уходи уже с этого проекта, Виталий :)

@vitamin2845 3 роки тому

@@BaJIePkA86 ахаха, не, я джун

@deniskochetkov6827 3 роки тому

По разному бывает. Бывает болото. А бывает, что за 10 лет много разного сделано и команды несколько раз перегруппировались. И есть офигенное развитие. Но болото чаще.

@ktotakoi6037 Рік тому

/// /// Так выглядит "Жаба док" в C# /// void Start()

@DimaVort 3 роки тому

Я думал javadoc в основном для интелисенса или как он у вас называется в ide? Autocomplit возможно. To do вобще божественная вещь. Даже если ide их не поддерживает можно закрутить по ним поиск в коде.

@cyberuser4160 3 роки тому

После этого видео у меня сфоримровалось довольно запутанное понимание о комментировании. В книге Стива Макконнелла "Совершенный код" призывают использовать псевдокод перед планированием метода, и описывать метод до его определения, то есть использовать Javadoc или его альтернативы, там приводится пример хорошо самодокументированного кода, но все равно комментируется каждая строка, а все ещё Сергей Немчинский призывает не писать комментарии когда код и так понятен, и что мне делать? Или это я не так понял кого то, или кто-то призывает к неправильному комментированию 👍