Теория: Оформление кода

Теперь, когда мы уже научились писать простые программы, можно немного поговорить о том, как их писать.

Код программы следует оформлять определенным образом, чтобы он был достаточно понятным и простым в поддержке. Специальные наборы правил — стандарты — описывают различные аспекты написания кода. Конкретно в C# самым распространенным стандартом является стандарт от Microsoft.

В любом языке программирования существуют утилиты — так называемые линтеры. Они проверяют код на соответствие стандартам, и могут сами поправить небольшие отклонения от стандарта. Для C# линтер является частью Visual Studio. Либо есть отдельная программа dotnet format

Взгляните на пример:

Console.WriteLine(8/2+5 - -3 / 2);

dotnet format будет «ругаться» на нарушение сразу в нескольких местах:

Program.cs(1,27): error WHITESPACE: Fix whitespace formatting. Insert ' ' Program.cs(1,28): error WHITESPACE: Fix whitespace formatting. Insert ' ' Program.cs(1,29): error WHITESPACE: Fix whitespace formatting. Insert ' ' Program.cs(1,30): error WHITESPACE: Fix whitespace formatting. Insert ' '

Program.cs – это имя файла в котором линтер нашел нарушение. Числа в скобка означают номер строки и символа в котором было обнаружено нарушение правил. WHITESPACE – правило, которое было нарушено. Это правило требует наличия пробелов между операторами и операндами. Оно не влияет на результат, но помогает писать код понятнее и проще для восприятия. Код с учетом этого правила выглядит так:

Console.WriteLine(8 / 2 + 5 - -3 / 2);

Теперь линтер ругаться не будет, но код все равно сложен для восприятия из-за отсутствия скобок. Лучше сделать так:

Console.WriteLine((8 / 2) + 5 - (-3 / 2));

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