Elementor Header #8

11. Оформление кода

1. Введение

Оформление кода играет ключевую роль в программировании. Чистый, читаемый и структурированный код облегчает его поддержку, понимание и исправление ошибок. В C# существуют официальные стандарты кодирования (C# Coding Conventions), которые помогают писать код более понятно и эффективно.


2. Основные принципы оформления кода

2.1. Использование отступов и форматирования

Правильное форматирование делает код читаемым. В C# принято использовать отступ в 4 пробела или табуляцию.

❌ Плохо:

				
					class Program{
static void Main(){Console.WriteLine("Hello, World!");}}

				
			

✅ Хорошо:

				
					class Program
{
    static void Main()
    {
        Console.WriteLine("Hello, World!");
    }
}

				
			

📌 Важно!
Всегда используйте автоматическое форматирование в редакторах, таких как Visual Studio (Ctrl + K, D).


2.2. Именование переменных, методов и классов

Классы и интерфейсы (PascalCase)

  • Названия классов начинаются с заглавной буквы.
  • Интерфейсы начинаются с I.
				
					class Employee { }
interface IWorker { }

				
			

Переменные и поля (camelCase)

  • Локальные переменные и поля начинаются с маленькой буквы
				
					int employeeCount;
double salary;
string fullName;

				
			
Константы (UPPER_CASE)
				
					const double PI = 3.14159;
const int MAX_USERS = 100;

				
			
Методы (PascalCase)
				
					void CalculateSalary() { }
string GetUserName() { }

				
			

Свойства (PascalCase)

				
					public string FirstName { get; set; }
public int Age { get; set; }

				
			

2.3. Использование скобок {}

В C# всегда ставьте {} для блоков кода, даже если они содержат одну строку.

❌ Плохо:

				
					if (x > 0) Console.WriteLine("Positive number");

				
			

✅ Хорошо:

				
					if (x > 0)
{
    Console.WriteLine("Positive number");
}

				
			

2.4. Комментарии

Комментарии помогают понять код, но не стоит злоупотреблять ими.

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

				
					// Выводит сообщение на экран
Console.WriteLine("Hello, World!");

				
			

Многострочные комментарии (/* ... */)

				
					/* Этот код вычисляет сумму двух чисел
   и выводит результат на экран */
int sum = a + b;
Console.WriteLine(sum);

				
			

XML-документация (///)

Используется для описания классов и методов.

				
					/// <summary>
/// Вычисляет сумму двух чисел.
/// </summary>
/// <param name="a">Первое число</param>
/// <param name="b">Второе число</param>
/// <returns>Сумма чисел</returns>
int Sum(int a, int b)
{
    return a + b;
}

				
			

2.5. Отступы и пробелы

  • Пробел перед {}:
				
					if (condition) 
{
    Console.WriteLine("True");
}

				
			
  • Пробелы вокруг операторов (=, +, -, *, /):
 
				
					int sum = a + b; // ✅ Хорошо
int sum=a+b;     // ❌ Плохо

				
			

3. Организация кода в файле

Файл кода должен иметь четкую структуру.

Пример правильной структуры файла в C#

				
					using System;

namespace MyApp
{
    /// <summary>
    /// Главный класс программы
    /// </summary>
    class Program
    {
        /// <summary>
        /// Точка входа в программу
        /// </summary>
        static void Main()
        {
            Console.WriteLine("Привет, мир!");
        }
    }
}

				
			

4. Конвенции по обработке ошибок

4.1. Использование try-catch-finally

Обрабатывайте исключения правильно:

❌ Плохо:

				
					int x = int.Parse(Console.ReadLine()); // Ошибка, если ввод не число!

				
			

✅ Хорошо:

				
					try
{
    int x = int.Parse(Console.ReadLine());
}
catch (FormatException)
{
    Console.WriteLine("Ошибка: введено не число!");
}

				
			

Заключение

Хороший код должен быть читаемым, логичным и аккуратно оформленным.
Соблюдайте следующие правила: ✔ Используйте четкие имена переменных и методов.
✔ Всегда форматируйте код (отступы, пробелы, скобки {}).
Добавляйте комментарии там, где это необходимо.
Обрабатывайте ошибки (try-catch).
✔ Следуйте конвенциям именования (PascalCase, camelCase, UPPER_CASE).

Следуя этим правилам, ваш код будет понятен не только вам, но и другим разработчикам! 🚀

5. Тестовое задание

Задание: Исправьте оформление кода

Исправьте код, чтобы он соответствовал правильному оформлению:

				
					using System;
class program{
static void Main(){
Console.WriteLine("Введите число:");
int num=int.Parse(Console.ReadLine());
if(num>0)Console.WriteLine("Число положительное"); else Console.WriteLine("Число отрицательное");
}}

				
			

Исправленный код:

				
					using System;

class Program
{
    static void Main()
    {
        Console.WriteLine("Введите число:");

        int num = int.Parse(Console.ReadLine());

        if (num > 0)
        {
            Console.WriteLine("Число положительное");
        }
        else
        {
            Console.WriteLine("Число отрицательное");
        }
    }
}

				
			

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

logo