Комментарий (компьютерное программирование)
В компьютерном программировании комментарий представляет собой читаемое программистом объяснение или аннотацию в исходном коде компьютерной программы . Они добавляются с целью облегчить понимание исходного кода людьми и обычно игнорируются компиляторами и интерпретаторами . [1] [2] Синтаксис комментариев в разных языках программирования значительно различается.
Комментарии иногда также обрабатываются различными способами для создания документации, внешней по отношению к самому исходному коду, с помощью генераторов документации или используются для интеграции с системами управления исходным кодом и другими видами внешних инструментов программирования .
Гибкость, обеспечиваемая комментариями, допускает большую степень вариативности, но формальные соглашения по их использованию обычно являются частью руководств по стилю программирования.
Комментарии обычно форматируются либо как блочные комментарии (также называемые комментариями пролога или комментариями потока ), либо как строчные комментарии (также называемые встроенными комментариями ). [3]
Блочные комментарии ограничивают область исходного кода, которая может занимать несколько строк или часть одной строки. Эта область определяется начальным и конечным разделителями. Некоторые языки программирования (например, MATLAB ) позволяют рекурсивно вкладывать комментарии блока друг в друга, но другие (например, Java ) этого не делают. [4] [5] [6]
Комментарии строки либо начинаются с разделителя комментариев и продолжаются до конца строки, либо, в некоторых случаях, начинаются с определенного столбца (смещение символьной строки) в исходном коде и продолжаются до конца строки. [6]
