Соглашения о написании кода на C# (Руководство по программированию на C#)C# Coding Conventions (C# Programming Guide)

Соглашения о написании кода предназначены для реализации следующих целей.Coding conventions serve the following purposes:

  • Создание согласованного вида кода, позволяющего читателям сосредоточиться на содержимом, а не на структуре.They create a consistent look to the code, so that readers can focus on content, not layout.

  • Предоставление читателям возможности делать предположения, основанные на опыте, и поэтому быстрее понимать код.They enable readers to understand the code more quickly by making assumptions based on previous experience.

  • Упрощение процессов копирования, изменения и обслуживания кода.They facilitate copying, changing, and maintaining the code.

  • Предоставление лучших методик C#.They demonstrate C# best practices.

Майкрософт использует приведенные в этом разделе рекомендации для разработки примеров и документации.The guidelines in this topic are used by Microsoft to develop samples and documentation.

Соглашения об именахNaming Conventions

  • В коротких примерах, не содержащих директив using, рекомендуется использовать полные указания для пространства имен.In short examples that do not include using directives, use namespace qualifications. Если известно, что пространство имен импортировано в проект по умолчанию, не требуется указывать полные имена из этого пространства имен.If you know that a namespace is imported by default in a project, you do not have to fully qualify the names from that namespace. Полные имена, если они слишком длинные для одной строки, можно разбить после точки (.), как показано в следующем примере.Qualified names can be broken after a dot (.) if they are too long for a single line, as shown in the following example.

    var currentPerformanceCounterCategory = new System.Diagnostics.
        PerformanceCounterCategory();
    
  • Нет необходимости изменять имена объектов, созданных с помощью инструментов разработки Visual Studio, чтобы привести их в соответствие с другими соглашениями.You do not have to change the names of objects that were created by using the Visual Studio designer tools to make them fit other guidelines.

Соглашения о расположенииLayout Conventions

Чтобы выделить структуру кода и облегчить чтение кода, в хорошем макете используется форматирование.Good layout uses formatting to emphasize the structure of your code and to make the code easier to read. Примеры и образцы корпорации Майкрософт соответствуют следующим соглашениям.Microsoft examples and samples conform to the following conventions:

  • Использование параметров редактора кода по умолчанию (логичные отступы, отступы по четыре символа, использование пробелов для табуляции).Use the default Code Editor settings (smart indenting, four-character indents, tabs saved as spaces). Дополнительные сведения см. в разделе "Параметры", "Текстовый редактор", C#, "Форматирование".For more information, see Options, Text Editor, C#, Formatting.

  • Запись только одного оператора в строке.Write only one statement per line.

  • Запись только одного объявления в строке.Write only one declaration per line.

  • Если отступ для дополнительных строк не ставится автоматически, необходимо сделать для них отступ на одну позицию табуляции (четыре пробела).If continuation lines are not indented automatically, indent them one tab stop (four spaces).

  • Добавление по крайней мере одной пустой строки между определениями методов и свойств.Add at least one blank line between method definitions and property definitions.

  • Использование скобок для ясности предложений в выражениях, как показано в следующем коде.Use parentheses to make clauses in an expression apparent, as shown in the following code.

    if ((val1 > val2) && (val1 > val3))
    {
        // Take appropriate action.
    }
    

Соглашения о комментарияхCommenting Conventions

  • Комментарий размещается на отдельной строке, а не в конце строки кода.Place the comment on a separate line, not at the end of a line of code.

  • Текст комментария начинается с заглавной буквы.Begin comment text with an uppercase letter.

  • Текст комментария завершается точкой.End comment text with a period.

  • Между разделителем комментария (/ /) и текстом комментария вставляется один пробел, как показано в следующем примере.Insert one space between the comment delimiter (//) and the comment text, as shown in the following example.

    // The following declaration creates a query. It does not run
    // the query.
    
  • Вокруг комментариев не должно быть звездочек.Do not create formatted blocks of asterisks around comments.

Рекомендации по работе с языкомLanguage Guidelines

В следующих подразделах описаны методики, которыми руководствуется команда C# для подготовки примеров и образцов кода.The following sections describe practices that the C# team follows to prepare code examples and samples.

Тип данных StringString Data Type

  • Для сцепления коротких строк рекомендуется использовать интерполяцию строк, как показано в следующем коде.Use string interpolation to concatenate short strings, as shown in the following code.

    string displayName = $"{nameList[n].LastName}, {nameList[n].FirstName}";
    
  • Для добавления строк в циклы, особенно при работе с текстами больших размеров, рекомендуется использовать объект StringBuilder.To append strings in loops, especially when you are working with large amounts of text, use a StringBuilder object.

    var phrase = "lalalalalalalalalalalalalalalalalalalalalalalalalalalalalala";
    var manyPhrases = new StringBuilder();
    for (var i = 0; i < 10000; i++)
    {
        manyPhrases.Append(phrase);
    }
    //Console.WriteLine("tra" + manyPhrases);
    

Неявно типизированные локальные переменныеImplicitly Typed Local Variables

  • В случаях, когда тип переменной понятен из правой части назначения или когда точный тип не важен, рекомендуется использовать неявное типизирование для локальных переменных.Use implicit typing for local variables when the type of the variable is obvious from the right side of the assignment, or when the precise type is not important.

    // When the type of a variable is clear from the context, use var 
    // in the declaration.
    var var1 = "This is clearly a string.";
    var var2 = 27;
    var var3 = Convert.ToInt32(Console.ReadLine());
    
  • Если тип из правой части назначения не является очевидным, не рекомендуется использовать var.Do not use var when the type is not apparent from the right side of the assignment.

    // When the type of a variable is not clear from the context, use an
    // explicit type.
    int var4 = ExampleClass.ResultSoFar();
    
  • При указании типа переменной не следует полагаться на имя переменной.Do not rely on the variable name to specify the type of the variable. Имя может быть неверным.It might not be correct.

    // Naming the following variable inputInt is misleading. 
    // It is a string.
    var inputInt = Console.ReadLine();
    Console.WriteLine(inputInt);
    
  • Рекомендуется избегать использования var вместо dynamic.Avoid the use of var in place of dynamic.

  • Рекомендуется использовать неявное типизирование для определения типа переменной цикла в циклах for и foreach.Use implicit typing to determine the type of the loop variable in for and foreach loops.

    В следующем примере неявное типизирование используется в операторе for.The following example uses implicit typing in a for statement.

    var syllable = "ha";
    var laugh = "";
    for (var i = 0; i < 10; i++)
    {
        laugh += syllable;
        Console.WriteLine(laugh);
    }
    

    В следующем примере неявное типизирование используется в операторе foreach.The following example uses implicit typing in a foreach statement.

    foreach (var ch in laugh)
    {
        if (ch == 'h')
            Console.Write("H");
        else
            Console.Write(ch);
    }
    Console.WriteLine();
    

Беззнаковый тип данныхUnsigned Data Type

  • Как правило, рекомендуется использовать int вместо беззнаковых типов.In general, use int rather than unsigned types. В C# обычно используется int. Использование int упрощает взаимодействие с другими библиотеками.The use of int is common throughout C#, and it is easier to interact with other libraries when you use int.

МассивыArrays

  • При инициализации массивов в строке объявления рекомендуется использовать сокращенный синтаксис.Use the concise syntax when you initialize arrays on the declaration line.

    // Preferred syntax. Note that you cannot use var here instead of string[].
    string[] vowels1 = { "a", "e", "i", "o", "u" };
    
    
    // If you use explicit instantiation, you can use var.
    var vowels2 = new string[] { "a", "e", "i", "o", "u" };
    
    // If you specify an array size, you must initialize the elements one at a time.
    var vowels3 = new string[5];
    vowels3[0] = "a";
    vowels3[1] = "e";
    // And so on.
    

ДелегатыDelegates

  • Для создания экземпляров типа делегата рекомендуется использовать сокращенный синтаксис.Use the concise syntax to create instances of a delegate type.

    // First, in class Program, define the delegate type and a method that  
    // has a matching signature.
    
    // Define the type.
    public delegate void Del(string message);
    
    // Define a method that has a matching signature.
    public static void DelMethod(string str)
    {
        Console.WriteLine("DelMethod argument: {0}", str);
    }
    
    // In the Main method, create an instance of Del.
    
    // Preferred: Create an instance of Del by using condensed syntax.
    Del exampleDel2 = DelMethod;
    
    // The following declaration uses the full syntax.
    Del exampleDel1 = new Del(DelMethod);
    

Операторы try-catch и using в процессе обработки исключенийtry-catch and using Statements in Exception Handling

  • Рекомендуется использовать оператор try-catch для обработки большей части исключений.Use a try-catch statement for most exception handling.

    static string GetValueFromArray(string[] array, int index)
    {
        try
        {
            return array[index];
        }
        catch (System.IndexOutOfRangeException ex)
        {
            Console.WriteLine("Index is out of range: {0}", index);
            throw;
        }
    }
    
  • Использование оператора C# using упрощает код.Simplify your code by using the C# using statement. При наличии оператора try-finally, код которого в блоке finally содержит только вызов метода Dispose, вместо него рекомендуется использовать оператор using.If you have a try-finally statement in which the only code in the finally block is a call to the Dispose method, use a using statement instead.

    // This try-finally statement only calls Dispose in the finally block.
    Font font1 = new Font("Arial", 10.0f);
    try
    {
        byte charset = font1.GdiCharSet;
    }
    finally
    {
        if (font1 != null)
        {
            ((IDisposable)font1).Dispose();
        }
    }
    
    
    // You can do the same thing with a using statement.
    using (Font font2 = new Font("Arial", 10.0f))
    {
        byte charset = font2.GdiCharSet;
    }
    

Операторы && и ||&& and || Operators

  • Чтобы избежать возникновения исключений и увеличить производительность за счет пропуска необязательных сравнений, рекомендуется использовать && вместо & и || вместо | при выполнении сравнений, как показано в следующем примере.To avoid exceptions and increase performance by skipping unnecessary comparisons, use && instead of & and || instead of | when you perform comparisons, as shown in the following example.

    Console.Write("Enter a dividend: ");
    var dividend = Convert.ToInt32(Console.ReadLine());
    
    Console.Write("Enter a divisor: ");
    var divisor = Convert.ToInt32(Console.ReadLine());
    
    // If the divisor is 0, the second clause in the following condition
    // causes a run-time error. The && operator short circuits when the
    // first expression is false. That is, it does not evaluate the
    // second expression. The & operator evaluates both, and causes 
    // a run-time error when divisor is 0.
    if ((divisor != 0) && (dividend / divisor > 0))
    {
        Console.WriteLine("Quotient: {0}", dividend / divisor);
    }
    else
    {
        Console.WriteLine("Attempted division by 0 ends up here.");
    }
    

Оператор NewNew Operator

  • Рекомендуется использовать сокращенную форму создания экземпляра для объекта с неявным типизированием, как показано в следующем объявлении.Use the concise form of object instantiation, with implicit typing, as shown in the following declaration.

    var instance1 = new ExampleClass();
    

    Предыдущая строка соответствует следующему объявлению.The previous line is equivalent to the following declaration.

    ExampleClass instance2 = new ExampleClass();
    
  • Рекомендуется использовать инициализаторы объектов для упрощения создания объектов.Use object initializers to simplify object creation.

    // Object initializer.
    var instance3 = new ExampleClass { Name = "Desktop", ID = 37414, 
        Location = "Redmond", Age = 2.3 };
    
    // Default constructor and assignment statements.
    var instance4 = new ExampleClass();
    instance4.Name = "Desktop";
    instance4.ID = 37414;
    instance4.Location = "Redmond";
    instance4.Age = 2.3;
    

Обработка событийEvent Handling

  • При определении обработчика событий, которого не требуется удалять позднее, рекомендуется использовать лямбда-выражение.If you are defining an event handler that you do not need to remove later, use a lambda expression.

    public Form2()
    {
        // You can use a lambda expression to define an event handler.
        this.Click += (s, e) =>
            {
                MessageBox.Show(
                    ((MouseEventArgs)e).Location.ToString());
            };
    }
    
    // Using a lambda expression shortens the following traditional definition.
    public Form1()
    {
        this.Click += new EventHandler(Form1_Click);
    }
    
    void Form1_Click(object sender, EventArgs e)
    {
        MessageBox.Show(((MouseEventArgs)e).Location.ToString());
    }
    

Статический членыStatic Members

  • Для вызова статических членов следует использовать имя класса: ClassName.StaticMember.Call static members by using the class name: ClassName.StaticMember. В этом случае код становится более удобочитаемым за счет четкого доступа.This practice makes code more readable by making static access clear. Не присваивайте статическому члену, определенному в базовом классе, имя производного класса.Do not qualify a static member defined in a base class with the name of a derived class. Во время компиляции кода его читаемость нарушается, и если добавить статический член с тем же именем в производный классе, код может быть поврежден.While that code compiles, the code readability is misleading, and the code may break in the future if you add a static member with the same name to the derived class.

Запросы LINQLINQ Queries

  • Используйте значимые имена для переменных запроса.Use meaningful names for query variables. В следующем примере используется seattleCustomers для клиентов, находящихся в Сиэтле.The following example uses seattleCustomers for customers who are located in Seattle.

    var seattleCustomers = from cust in customers
                           where cust.City == "Seattle"
                           select cust.Name;
    
  • Рекомендуется использовать псевдонимы для уверенности в том, что в именах свойств анонимных типов верно используются прописные буквы при помощи правил использования прописных и строчных букв языка Pascal.Use aliases to make sure that property names of anonymous types are correctly capitalized, using Pascal casing.

    var localDistributors =
        from customer in customers
        join distributor in distributors on customer.City equals distributor.City
        select new { Customer = customer, Distributor = distributor };
    
  • Переименуйте свойства, если имена свойств в результате могут быть неоднозначными.Rename properties when the property names in the result would be ambiguous. Например, если запрос возвращает имя клиента и идентификатор распространителя, не оставляйте имена в виде Name и ID, а переименуйте их, чтобы было ясно, что Name — имя клиента и ID — идентификатор распространителя.For example, if your query returns a customer name and a distributor ID, instead of leaving them as Name and ID in the result, rename them to clarify that Name is the name of a customer, and ID is the ID of a distributor.

    var localDistributors2 =
        from cust in customers
        join dist in distributors on cust.City equals dist.City
        select new { CustomerName = cust.Name, DistributorID = dist.ID };
    
  • Рекомендуется использовать неявное типизирование в объявлении переменных запроса и переменных диапазона.Use implicit typing in the declaration of query variables and range variables.

    var seattleCustomers = from cust in customers
                           where cust.City == "Seattle"
                           select cust.Name;
    
  • Выравнивайте предложения запроса под предложением from, как показано в предыдущих примерах.Align query clauses under the from clause, as shown in the previous examples.

  • Чтобы гарантировать, что более поздние предложения запроса работают с ограниченным, отфильтрованным набором данных, используйте предложение where перед другими предложениями запроса.Use where clauses before other query clauses to ensure that later query clauses operate on the reduced, filtered set of data.

    var seattleCustomers2 = from cust in customers
                            where cust.City == "Seattle"
                            orderby cust.Name
                            select cust;
    
  • Используйте несколько предложений from для доступа к внутренним коллекциям вместо предложения join.Use multiple from clauses instead of a join clause to access inner collections. Например, коллекция объектов Student может содержать коллекцию результатов тестирования.For example, a collection of Student objects might each contain a collection of test scores. При выполнении следующего запроса возвращаются результаты, превышающие 90 балов, а также фамилии учащихся, получивших такие оценки.When the following query is executed, it returns each score that is over 90, along with the last name of the student who received the score.

    // Use a compound from to access the inner sequence within each element.
    var scoreQuery = from student in students
                     from score in student.Scores
                     where score > 90
                     select new { Last = student.LastName, score };
    

БезопасностьSecurity

Следуйте указаниям, изложенным в правилах написания безопасного кода.Follow the guidelines in Secure Coding Guidelines.

См. такжеSee Also