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