При написании любого программного кода программисты зачастую пишут комментарии, что бы в будущем другой программист (который будет просто использовать написанный код или его модифицировать) мог понимать что за что отвечает (например, что делает тот или иной блок программного кода).
Нужно заметить, что на комментарии будут обращать внимание только люди, но не интерпретатор или же компилятор. Данные «переводчики» при встрече с комментарием будут его просто игнорировать, поэтому комментарии никак не влияют на работу разрабатываемой программы, а лишь помогаю разработчикам оставлять описание к программному коду или же оставлять отдельные заметки для себя.
В языке C# существует два вида комментариев:
- Строчный комментарий
- Блочный комментарий
Строчный комментарий работает следующим образом: в строке идёт описание инструкции (необязательно) после чего пишется «//» - это и будет обозначать, что весь текст после «//» будет комментарием и его при компиляции обрабатывать ненужно. Указывать где заканчивается комментарий ненужно.
Блочный комментарий работает похожим образом, но у блочного комментария есть символы его начала («/») и конца (/). Блочный комментарий может включать в себя несколько строк. У данного вида комментариев всегда должен быть конец, иначе будет ошибка на этапе компиляции.
Снизу приведено примеры написания комментариев к коду в Visual Studio. По умолчанию комментарии выделяются зелёным цветом.
предыдущая статья