Философия программирования на C++ Выпуск 6. Комментарии
Приветствую вас!
В прошлом выпуске мы рассказывали вам о математических операциях в C++. Но мы на самом деле немножко схитрили и использовали еще кое-что, о чем не упомянули ранее.
Это, пожалуй, самая важная тема во всем программировании - это комментарии в коде. Да-да, они действительно очень и очень важны и необходимы, и вот некоторые причины этого:
Первым пунктом напишем то, что говорят почти все и всегда: комментарии помогают не забыть, что вы написали месяц назад! Это действительно
важно, поскольку каждый раз начинать программу с нуля - не самая правильная идея. Просто потому, что в каждой новой программе можно использовать участок кода из старой. А если вы его забудете (а через месяц вы его точно забудете) - то никак вы не вспомните, что же это и как оно работает.
Комментарии позволяют отдать ваш код другому человеку без опасений, что придется целый месяц ему объяснять, что делает каждая строчка. Он все сможет понять из хорошо написанных комментариев!
В комментариях часто
пишут официальную документацию по написанной библиотеке (на самом деле "старый код", который можно использовать заново, обычно называется библиотекой - library). По ней легко разобраться, как можно использовать ее (очень похоже на предыдущий пункт).
Комментарии позволяют сохранить старый код, сделав его неработающим. Просто закомментируем те строчки, которые больше не должны работать - и все!
Пожалуй я не буду перечислять дальше, суть примерно одна и та же. Комментарии - это
не то, что позволяет облегчить написание кода. Наоборот, всем как правило лениво их писать, поскольку дело это не такое простое, как кажется.
Комментарии помогают читать(!) код. Многих удивляет такой простой факт: ваш код будут читать гораздо чаще, чем вы думаете. Вы сами, ваши коллеги, совершенно чужие люди (если вы им его откроете в интернете). А писать вы его будете гораздо меньше. Поэтому рекомендую применять дальше простое правило:
Пишите код не для себя, а для других!
Позвольте
людям лучше понять вашу мысль в вашем коде!
Это были вводные слова, а теперь перейдем к техническим вопросам.
Комментарии - это по сути код, который компилятор игнорирует. Перед запусков собственно компиляции, все комментарии заменяются на один пробел. Поэтому-то комментарии и важны только для самого разработчика - на программу они никак не действуют.
Мы их писали в предыдущем выпуске. Применяются они очень просто: пишем "//" и после этого вся строчка является комментарием. Пример:
Вот и все. Ах да, пару слов про многострочные комментарии. Они начинаются с символов /* и завершаются */ . Ничего особенно хитрого в этом нет.
В дальнейшем мы будем стараться использовать комментарии там, где у вас могут возникнуть сложности с кодом. Удобнее его объяснять прямо рядом со строчкой кода, чем потом писать много текста, как я это делаю сейчас :) .