Комментирование кода — это процесс написания поясняющих строк в программном коде, которые позволяют понять смысл написанного.

Зачем нам это нужно?

1️⃣ Чтобы другие люди могли легко понимать наш код и работать с ним.
2️⃣ Чтобы мы сами не забыли, что именно делает тот или иной кусок кода, когда через какое-то время вернемся к проекту.

Как комментарии оформляют в коде

// — однострочные в языках C, C++, PHP, C#, Java и JavaScript
# — однострочный в Python, PHP
/* */ — многострочные в C, C++, PHP, C#, Java, JavaScript

Несколько советов, как правильно комментировать код:

✔️ Пишите комментарии прямо над кодом, к которому они относятся
✔️ Пишите их на языке, на котором программируете
✔️ Поясняйте сложные части кода, которые могут вызвать вопросы
✔️ Обновляйте комментарии, когда меняете свой код

❗️ВАЖНО. Комментариев должно быть мало, иначе они превратятся во флуд. Комментировать нужно основные элементы кода, неочевидные и сложные решения и т.д.

Кстати, в комментариях вы можете поделиться комментариями о комментариях 💬