Нужно ли комментировать исходный код?
Как известно, комментарии —это поясняющие строки в программном коде, которые позволяют понять смысл написанного. Они пишутся для людей, но игнорируются компиляторами.
Комментарии делают сразу несколько полезных вещей:
1) Помогают быстрее разобраться в коде. Это важно и разработчику, и тем, кто будет заниматься кодом после него.
2) Не дают запутаться в логике — при создании новых библиотек, функций и системных переменных.
3) Объясняют результаты работы. Это понимание необходимо тестировщикам из отдела QA.
4) Описывают сложные алгоритмы и формулы. Это позволяет разобраться в готовом коде тем, у кого нет глубоких знаний в какой-то предметной области.
Но иногда эти пояснения только ухудшают наглядность кода, бывают бессмысленны и даже вредны. Например, совершенно не нужны комментарии, просто пересказывающие действия программы, поэтому в зависимости от ситуации каждый сам решает, нужны ли в его коде комментарии или нет.
