Введение

  • 3 мин

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

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

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

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

Внимание

Этот модуль включает действия программирования, требующие Visual Studio Code. Вам потребуется доступ к среде разработки с установленным и настроенным visual Studio Code для разработки приложений C#.

Цели обучения

Изучив этот модуль, вы сможете:

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

Необходимые компоненты

  • Опыт работы с Visual Studio Code для создания и запуска консольных приложений C#.
  • Работа с печатью сообщений в консоли с помощью Console.WriteLine().
  • Опыт использования if и else if инструкций для создания ветвей кода.