О комментариях в коде.
Коллеги-программисты, наверное, многие из нас при написании программы никогда не задумываемся о написании комментариев к свему коду. Судя по своему опыту, это прежде всего связано с тем, что я думаю о том, что это мой код, это мой стиль написания, и я и так знаю, что где происходит, посему и не люблю тратить время на комментирование участков кода.
Точнее не любил тратить время.
Сейчас все поменялось.
Помимо написания аккуратного кода, я стараюсь по максимуму снабжать его комментариями. И как чудесно потом по прошествии времени видеть комментарии и тут же мгновенно получать в голове картину происходящего. Также чудесно это и при коллективной разработке. Коллеги гораздо быстрее вникнут в суть процедуры, функции и прочего участка кода, если он снабжен пояснениями.
Со временем понимаешь важность потраченных драгоценных минут на создание пояснений к написанному методу, процедуре и т.п. Также со временем я пришел к выводу, что к коментариям применимо простое правило: комментарий для строчки кода должен быть короткий и понятный, а для логического блока максимально объясняющий что к чему.
Так что задаваясь вопросом, что можно улучшить в коде, который и так уже работает и выполняет возложенные на него функции, и услышав совет связанный с применением комментариев в коде, подойдите к этому совету посерьезнее и выделите столь драгоценное время сейчас на комментирование кода, дабы сэкономить его потом в кратном размере при чтении кода по прошествии времени.