В компьютерном программировании комментарий — это читаемое программистом объяснение или аннотация в исходном коде компьютерной программы. Они добавляются с целью облегчения понимания исходного кода путем предоставления пояснений к различным частям кода. Комментарии могут использоваться для объяснения назначения определенного участка кода, предоставления информации об используемом алгоритме или описания любых известных ограничений или ошибок.
В Go комментарии можно добавлять двумя способами:
Однострочные комментарии: они начинаются с символов // и продолжаются до конца строки. Например:
// Это однострочный комментарий
Многострочные комментарии: они начинаются с символов /* и заканчиваются символами */. Например:
/*
Это многострочный
комментарий, который может охватывать
несколько строк
*/
Важно отметить, что компилятор Go игнорирует комментарии, поэтому они никак не влияют на выполнение программы.
Пример использования комментариев в программе: https://go.dev/play/p/mBqZczdBGpv
В этом простом примере комментарии содержат пояснения к коду и назначению различных частей программы. Комментарии помогают сделать код более читабельным и легким для понимания.
Вы конечно можете сказать, что зачем комментировать то, что и так понятно, но несмотря на простоту примера рекомендуется использовать комментарии везде и всегда, то что понятно вам здесь и сейчас может легко стать "китайской грамотой" через 2-3 месяца. Время затраченное на восстановление в мозге неизвестных науке конструкций и понимания, а что же собственно код делает может быть многократно больше, чем написание простого комментария. Не ленитесь писать комментарии!
И еще один небольшой совет: Старайтесь писать комментарии так, как будто вы пытаетесь объяснить что-то человеку, который не понимает в программировании ничего, иначе можете попасть в ситуацию, когда желательно сначала понять, что написано в комментарии и только потом понять комментируемый код.