Руководство для начинающих по программированию с .NET 5 и C #

В этой статье мы узнаем, как писать комментарии. Комментарии - это просто удобочитаемые фрагменты текста, которые не компилируются и не интерпретируются. Комментарий обычно представляет собой примечание, которое мы можем оставить в коде, чтобы следующий программист мог войти в этот код или для нас. Я оставил несколько комментариев в предыдущих частях; ты их заметил?

Эта статья является частью серии изучайте программирование, в которой вам не нужны предварительные знания программирования. Если вы хотите научиться программировать и хотите изучить это с помощью .NET / C #, это правильное место. Я предлагаю прочитать всю серию по порядку, начиная с Создание вашей первой программы .NET / C #, но это не обязательно.

Комментарии

В C # есть три типа комментариев:

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

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

Мы можем использовать комментарии, чтобы оставлять заметки в исходном коде. Новичку могут пригодиться комментарии. Чем больше вы продвигаетесь, тем яснее станет ваш код и тем реже будут нужны комментарии.

Дополнительная информация: я обычно рекомендую разработчикам среднего уровня писать в своем коде как можно меньше комментариев. Комментарии слишком часто устаревают и забываются.

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

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

Затем давайте посмотрим на первый стиль, который мы рассмотрим в этой статье.

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

Мы можем написать однострочный комментарий, написав //. Все, что написано потом в той же строке, становится комментарием, который ничего не делает.

Вот некоторые примеры:

const string tmp = "SOME TEXT"; // This is a comment that could describe this statement
// This is a comment that could describe the following code block
Console.WriteLine("=====================");
Console.Write("===== ");
Console.Write(tmp);
Console.WriteLine(" =====");
Console.WriteLine("=====================");

Если мы запустим код, мы получим следующий вывод:

=====================
===== SOME TEXT =====
=====================

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

Теперь давайте посмотрим на многострочные комментарии.

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

Многострочные комментарии похожи на их название: они могут охватывать несколько строк. В отличие от однострочных комментариев, многострочные комментарии имеют начальную и конечную последовательность символов. Все, что находится между этими двумя токенами, является комментарием. Мы можем открыть многострочный комментарий с помощью /* и закрыть его с помощью */ (те же символы в перевернутом порядке).

Подсказка: цифровая клавиатура стандартной клавиатуры позволяет очень легко открывать и закрывать многострочные комментарии с помощью плавной последовательности нажатий клавиш: / - ›* -› * - ›/ -› переместите стрелку между двумя *, нажмите enter или напишите свой комментарий.

Вот несколько примеров:

/* This is a multiline comment, but only on one line; please don't do what I did with the following line in your code, it is just an example. */
const/* This */string/* can */tmp/* be */=/* almost */"SOME TEXT"/* anywhere, */;/* as long as you don't break any token */
//
// We can also use single-line comments; one does not block the usage of the other.
//
Console.WriteLine("=====================");
/*
We can also
use multiline
comments to
write longer
sequence of
text divided
onto multiple
lines.
*/
Console.Write("===== ");
Console.Write(tmp);
Console.WriteLine(" =====");
Console.WriteLine("=====================");

Когда мы запускаем код, мы получаем следующий вывод:

=====================
===== SOME TEXT =====
=====================

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

И вуаля! Вы сделали еще один шаг к обучению программированию.

Вывод

Комментарии - это инструмент для аннотирования и оставления заметок внутри кода. Мы можем писать однострочные комментарии, начинающиеся с //, и мы можем писать многострочные комментарии между /* и */.

В комментариях важно понимать, что их следует использовать для функционального описания, а не самого кода. Например, объяснение программисту C # с помощью комментария того, что var text = "whatever"; создает переменную с именем text, бесполезно. Но объяснение того, что следующий блок кода является реализацией алгоритма XYZ, могло бы быть. Как я уже упоминал, в какой-то момент вы захотите написать достаточно ясный код, чтобы вам не приходилось его объяснять. Тем не менее, как новичок, пожалуйста, используйте комментарии, чтобы помочь вам. Вы можете описать свой код, например, если это поможет вам запомнить или понять. Все учатся по-разному. Нет ничего плохого в том, как учиться, поэтому, если использование комментариев вам поможет, сделайте это! Если вы не знаете, поэкспериментируйте с техниками и оставьте то, что лучше всего подходит для вас, только вы можете узнать эту часть.

Следующий шаг

Пришло время перейти к следующей статье: ** Введение в пользовательский ввод **, которая скоро появится. Следите за мной, подписавшись на меня на Medium, Twitter или в других местах, где вы можете меня найти. Вы можете посмотреть [страницу контактов в моем блоге] (https://www.forevolve.com/contact/) для получения дополнительной информации.

Первоначально опубликовано на https://www.forevolve.com 7 марта 2021 г.