Добавить в корзинуПозвонить
Найти в Дзене
Заметки БыдлоКодера

Комментарии - this good?

Всем привет, что я знаю о комментариях в коде? Да так же, как и Вы, редко использую, но злюсь, когда встречаю чужой код без комментариев и вообще, нужны ли они на самом деле? Какие типы комментов я знаю? Кэп очевидности И так, комменты из жанра - Кэп очевидности. Кто эти люди, и зачем они так делают? Я один из этих людей и я так делаю, для того, что бы поставить себе некую "метку", что быстро найти нужный мне блок кода, смешно, банально, но именно так я отмечаю себе зоны работы, простите меня те, кто читал мой код, я не специально. Вот Вы смеетесь, а очевидные комментарии порой помогают начинающим программистам понять, что вообще здесь происходит. Warning! Danger ZONE! Это порой самое полезное, что я встречал. Серьезно, изучая чужие проекты, комментарии в таком духе, дают понять - Тут все не так просто, как ты думаешь. Это значит, что до меня тут побывал другой программист, и как в какой-то игре на выживание, он оставил мне послание. Люблю такие комментарии, польза от них ес
Оглавление

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

Какие типы комментов я знаю?

  1. Кэп Очевидности - Это когда очевидный блок кода, комментируют, зачем?
  2. Warning! Danger ZONE! - Это когда комментарий просто ничего не объясняет, но там есть знаменитое //Я "мат" знает, как оно работает
  3. Комментарий "книга" - Это когда ооочень много текста, просто не знаю, зачем столько пишут люди? Смешнее всего, если этот комментарий относится к банальным вещам.
Примерно так я вижу комментирование многих проектов
Примерно так я вижу комментирование многих проектов

Кэп очевидности

И так, комменты из жанра - Кэп очевидности.

Кто эти люди, и зачем они так делают?

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

Пример
Пример

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

Warning! Danger ZONE!

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

Люблю такие комментарии, польза от них есть.

Да, порой таких комментариев не хватает
Да, порой таких комментариев не хватает

Комментарий "книга"

Так же, очень полезный тип комментариев. Встречаю их редко, но и от них есть польза, если использовать с умом.

И такое встречается
И такое встречается

То, что встречается редко

Редко, очень редко встречаю самый полезный тип комментариев, а именно - Описание. Что за метод, что за класс, как оно работает и на кой лясон оно там вообще есть? - Это загадка.

Это куда лучше, чем пустота
Это куда лучше, чем пустота
Оригинально, но не информативно
Оригинально, но не информативно

Большое спасибо за прочтение статьи, помните: Лайк + подписка мотивируют лучше чем найденная ";"