Урок 2. C# комментарии

Все уроки по C# расположены здесь.

В этом уроке по основам C# мы рассмотрим добавление комментариев или замечаний в программном коде. Комментирование имеет большое значение при командной разработке или при поддержке кода, который пересматривается только периодически.

Что такое комментарий?

Комментарий содержит информацию, которую программист хочет добавить для описания программы. Комментарии помечаются специальными символами, указывающими на то, что они должны игнорироваться компилятором. Они не влияют на конечное программное обеспечение.

Когда комментировать

Комментарии могут использоваться по многим причинам. Вы можете прокомментировать свой код, чтобы убедиться, что ваши комментарии полезны. Ниже перечислены некоторые элементы, которые часто комментируются

• Методы. Комментарий может быть добавлен к методам, функциям или подпрограммам программы. Они могут описать, что подпрограмма должна делать и какая информация возвращается после завершения.


• Сложные операции. Любое реализованное правило, которое не сразу понятно, должно содержать комментарий, поясняющий цель операции. Однако если код является неоправданно сложным, а не правило, которое является необычным, следует провести рефакторинг кода, чтобы облегчить его чтение. Комментарии не являются альтернативой высококачественному коду.


• Код файлов. Каждый файл или программа могут содержать комментарии, такие как заголовок, автор программы, дата создания и номер версии. Другие примечания также могут быть добавлены, например, история версий или какие-либо предпосылки для работы программы.


• Изменения кода. При работе в команде может быть полезно добавлять комментарий при каждом изменении кода. Они могут включать в себя имя программиста, вносящего изменения, номер версии программного обеспечения и дату. Одна или несколько строк кода могут быть помечены как комментарий, чтобы удалить его из скомпилированной программы, не удаляя его из исходного кода. Это называется комментирование кода. Вы должны также рассмотреть возможность использования системы контроля версий, чтобы эффективнее управлять изменениями.

Как комментировать

Теперь, когда мы поняли, что и когда комментировать, надо узнать, как комментировать. Существует три типа комментариев, которые можно включить в C#. Это однострочные, завершающие и многострочные комментарии.

Однострочные комментарии

Самая простая форма комментария в c# - это однострочный комментарий. Линия начинается с двойной косой черты (//). Любой текст или код, следующий за двойной косой чертой, игнорируется во время компиляции.

// Это комментарий и следующая строка закомментированы
// Console.WriteLine("Hello, World");

Завершающие комментарии

Завершающий комментарий - это вариант однострочного комментария. В этом случае двойная косая черта появляется в конце строки. Любой код перед символом комментария рассматривается как часть программы. Код после символа - это комментарий.

Console.WriteLine("Hello, World");   // Вывод строки

Многострочные комментарии

Последний Тип комментария - это многострочный комментарий. Он включает начальный символ (/ *) и конечный символ (*/). Любая информация между двумя символами рассматривается как комментарий. Это полезно для комментирования больших блоков кода.

/* Это многострочный комментарий
    и продолжается до конца
    символа комментария*/

Предыдущий: Урок 1. HelloWorld | Следующий: Урок 3. Числовые типы данных в C#