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