Кодирование похоже на написание прозы. Каждый человек делает это немного по-своему, и в результате, когда наш код читается, у всех нас есть отчетливый голос. У всех нас есть разные соглашения об именах и логика решения проблем. Мы все думаем, что наш код имеет смысл, особенно если он работает, но возможно, что это не так для кого-то другого. Чтобы бороться с этим, нам всем нужно научиться лучше комментировать код. Таким образом, у любого, кто придет к проекту, будет четкий путь к пониманию и улучшению / исправлению нашего кода.
Для начала давайте удостоверимся, что все мы на одной странице в отношении того, что такое комментарии. В компьютерном программировании комментарий - это понятное программисту объяснение или аннотация в исходном коде компьютерной программы. Они добавляются с целью облегчения понимания исходного кода людьми и обычно игнорируются компиляторами и интерпретаторами. Синтаксис комментариев в разных языках программирования значительно различается.
Программы должны быть написаны для того, чтобы люди могли их читать, и только в случае необходимости для выполнения машинами.
Вы комментируете код, который пишете? Если вы похожи на большинство людей, ответ на этот вопрос отрицательный. Но ты должен! Комментирование кода может быть полезным во многих отношениях, чем вы могли ожидать.
Вот три причины, по которым полезно комментировать код, даже когда вы учитесь:
1. Объяснение того, что делает код, поможет вам запомнить, что он делает.
Использование комментариев для описания кода на вашем собственном языке, как при ведении заметок или отладке «резиновой утки», помогает вам вспомнить, как он работает. Это также может привлечь внимание к проблемным участкам. Если вы не можете понять, как работает ваш код, или не можете придумать полезный комментарий, это признак того, что вам нужно еще раз вернуться к этой концепции.
2. Это поможет вам продолжить с того места, на котором вы остановились.
У большинства из нас жизнь и карьера делают невозможным обучение на постоянной основе. Если вы комментируете свой код во время изучения, вы можете проверить комментарии при следующем входе в систему, чтобы получить краткое изложение того, что вы только что узнали. Поскольку эти комментарии будут вашими личными объяснениями, написанными вашими собственными словами, этот метод просмотра кода, скорее всего, будет проще и эффективнее, чем попытки перечитать урок, чтобы наверстать упущенное.
3. Лучше всего сформировать хорошие привычки.
Вероятно, никто другой не будет смотреть на код, который вы пишете, пока вы работаете над личным проектом. Вы можете даже не смотреть на это снова. Но даже если это так, все же неплохо иметь привычку комментировать свой код. Выработка этой привычки сейчас может избавить вас от многих головных болей в будущем!
прокомментируйте свой код в следующий раз, когда будете работать над проектом. Это может помочь вам учиться более эффективно, и даже если этого не произойдет, вы будете формировать полезные привычки на будущее. Какие у вас есть советы и рекомендации, как получить максимальную отдачу от комментирования кода?
