10 советов по написанию лучшего кода на C#

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

Рассмотрим основные 10 советов по написанию лучшего кода на C#:

1. По возможности используйте типы, доступные только для чтения, и неизменяемые типы

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

// Неизменяемые, доступные для чтения типы
readonly struct Point
{
    public int X { get; }
    public int Y { get; }

    public Point(int x, int y)
    {
        X = x;
        Y = y;
    }
}

2. Используйте ключевое слово var, чтобы избежать объявления ненужных типов переменных

Компилятор может определить тип переменной из контекста, поэтому вам не нужно объявлять ее явно.

// ключевое слово var
var point = new Point(10, 20);

3. Используйте операторы с нулевым условным обозначением, чтобы избежать исключений, связанных с нулевыми ссылками

Условные операторы с null позволяют безопасно проверять наличие нулевых значений и выполнять код только в том случае, если значение не равно null.

if (point is not null)
{
    Console.WriteLine(point.X);
}

4. Используйте сопоставление с образцом для упрощения сложных условных выражений

Сопоставление с шаблоном позволяет сопоставить значение переменной с шаблоном и выполнить различный код в зависимости от совпадения.

// Сопоставление с шаблоном
switch (point)
{
    case (10, 20):
        Console.WriteLine("Координаты точки совпадают (10, 20)");
        break;
    default:
        Console.WriteLine("Координаты точки не совпадают (10, 20)");
        break;
}

5. Используйте кортежи для возврата нескольких значений из метода

Кортежи - это простой и эффективный способ возвращать несколько значений из метода без необходимости создавать пользовательский класс.

// кортежи
(int x, int y) = point;

6. Используйте оператор nameof, чтобы получить имя переменной или элемента во время компиляции

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

// оператор nameof
Console.WriteLine(nameof(point.X));

7. Используйте инструкцию using для правильного использования ресурсов

Инструкция using гарантирует, что ресурсы будут удалены, даже если возникнет исключение

// инструкция using
using (var stream = new FileStream("myfile.txt", FileMode.OpenOrCreate))
{
    // Запись в поток
}

8. По возможности используйте выражения LINQ вместо циклов

Выражения LINQ - это лаконичный и мощный способ запроса коллекций данных и управления ими.

// выражения LINQ
var points = new List<Point>() { new Point(10, 20), new Point(30, 40) };
var filteredPoints = points.Where(p => p.X > 20);

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

Методы расширения позволяют добавлять новые методы к существующим классам без необходимости изменять исходные определения классов.

// методы расширения
public static string ToUpper(this string str)
{
    return str.ToUpperInvariant();
}

var str = "привет мир";
var upperCaseStr = str.ToUpper();

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

Методы генераторы (или дженерики) позволяют писать код, который можно использовать с различными типами данных, без необходимости писать отдельные версии кода для каждого типа данных.

// generics
public class List<T>
{
    public void Add(T item)
    {
        // ...
    }
}

var pointList = new List<Point>();
pointList.Add(new Point(10, 20));
pointList.Add(new Point(30, 40));

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

Рассмотрим еще несколько советов, не относящихся к C#, но не менее важных:

Используйте async/await, чтобы сделать ваш код более отзывчивым

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

Используйте описательные имена переменных.

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

Сгруппируйте связанный код вместе.

Это облегчит чтение и понимание вашего кода. Например, вы можете сгруппировать весь код для определенной функции в отдельный класс или пространство имен.

Используйте юнит тесты.

Юнит (или модульные) тесты - отличный способ протестировать ваш код и убедиться, что он работает должным образом.

Регулярно проводите рефакторинг своего кода.

Рефакторинг - это процесс улучшения структуры и дизайна вашего кода без изменения его функциональности. Это сделает ваш код более удобным в обслуживании и многократном использовании.

Используйте шаблоны проектирования

Шаблоны проектирования - это многократно используемые решения распространенных проблем разработки программного обеспечения. Использование шаблонов проектирования может сделать ваш код более эффективным, удобным в обслуживании и расширяемым.