Codekonventionen für C# (C#-Programmierhandbuch)C# Coding Conventions (C# Programming Guide)

Die C#-Sprachspezifikation definiert keinen Codierungsstandard.The C# Language Specification does not define a coding standard. Die Richtlinien in diesem Thema werden jedoch von Microsoft verwendet, um Beispiele und die Dokumentation zu entwickeln.However, the guidelines in this topic are used by Microsoft to develop samples and documentation.

Codierungskonventionen dienen den folgenden Zwecken:Coding conventions serve the following purposes:

  • Sie kreieren ein konsistentes Erscheinungsbild des Codes, sodass Leser sich auf den Inhalt und nicht auf das Layout konzentrieren können.They create a consistent look to the code, so that readers can focus on content, not layout.

  • Sie ermöglichen es den Lesern, Code schneller zu verstehen, da Rückschlüsse basierend auf den bisherigen Erfahrungen gezogen werden können.They enable readers to understand the code more quickly by making assumptions based on previous experience.

  • Sie erleichtern das Kopieren, Ändern und Pflegen des Codes.They facilitate copying, changing, and maintaining the code.

  • Sie zeigen die Best Practices für C#.They demonstrate C# best practices.

NamenskonventionenNaming Conventions

  • Verwenden Sie Namespacequalifizierungen in kurzen Beispielen, die keine using-Anweisungen umfassen.In short examples that do not include using directives, use namespace qualifications. Wenn Sie wissen, dass ein Namespace standardmäßig in ein Projekt importiert wird, müssen Sie den Namen aus diesem Namespace nicht voll qualifizieren.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. Qualifizierte Namen können nach einem Punkt (.) unterbrochen werden, wenn sie für eine einzelne Zeile zu lang sind, wie im folgenden Beispiel gezeigt.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();
    
  • Sie müssen nicht die Namen der Objekte ändern, die mit den Designertools von Visual Studio erstellt wurden, um sie an andere Richtlinien anzupassen.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.

LayoutkonventionenLayout Conventions

Ein gutes Layout verwendet Formatierungen, um die Struktur des Codes hervorzuheben und um den Code verständlicher zu gestalten.Good layout uses formatting to emphasize the structure of your code and to make the code easier to read. Microsoft-Beispiele entsprechen den folgenden Konventionen:Microsoft examples and samples conform to the following conventions:

  • Verwenden Sie die Code-Editor-Standardeinstellungen (Intelligenter Einzug, vierstelliger Einzug, als Leerzeichen gespeicherte Tabulatoren).Use the default Code Editor settings (smart indenting, four-character indents, tabs saved as spaces). Weitere Informationen finden Sie unter Optionen, Text-Editor, C#, Formatierung.For more information, see Options, Text Editor, C#, Formatting.

  • Schreiben Sie pro Zeile nur eine Anweisung.Write only one statement per line.

  • Schreiben Sie pro Zeile nur eine Deklaration.Write only one declaration per line.

  • Wenn Fortsetzungszeilen nicht automatisch eingezogen werden, rücken Sie diese um einen Tabstopp (vier Leerzeichen) ein.If continuation lines are not indented automatically, indent them one tab stop (four spaces).

  • Fügen Sie zwischen Methoden- und Eigenschaftsdefinitionen mindestens eine Leerzeile ein.Add at least one blank line between method definitions and property definitions.

  • Verwenden Sie Klammern, um Klauseln in einem Ausdruck zu kennzeichnen, wie im folgenden Code gezeigt.Use parentheses to make clauses in an expression apparent, as shown in the following code.

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

Konventionen für KommentareCommenting Conventions

  • Fügen Sie den Kommentar in einer eigenen Zeile und nicht am Ende einer Codezeile ein.Place the comment on a separate line, not at the end of a line of code.

  • Beginnen Sie Kommentartext mit einem Großbuchstaben.Begin comment text with an uppercase letter.

  • Beenden Sie den Kommentartext mit einem Punkt.End comment text with a period.

  • Fügen Sie ein Leerzeichen zwischen dem Kommentartrennzeichen (//) und dem Kommentartext ein, wie im folgenden Beispiel gezeigt.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.
    
  • Erstellen Sie keine formatierten Blöcke mit Sternchen um Kommentare.Do not create formatted blocks of asterisks around comments.

SprachrichtlinienLanguage Guidelines

In den folgenden Abschnitten werden die Vorgehensweisen beschrieben, denen das C#-Team folgt, um Codebeispiele zu erstellen.The following sections describe practices that the C# team follows to prepare code examples and samples.

String-DatentypString Data Type

  • Verwenden Sie den +-Operator, um kurze Zeichenfolgen zu verketten, wie im folgenden Code gezeigt.Use the + operator to concatenate short strings, as shown in the following code.

    string displayName = nameList[n].LastName + ", " + nameList[n].FirstName;
    
  • Verwenden Sie ein StringBuilder-Objekt, um Zeichenfolgen in Schleifen anzufügen, besonders bei der Arbeit mit großen Textmengen.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);
    

Implizit typisierte lokale VariablenImplicitly Typed Local Variables

  • Verwenden Sie die implizite Typisierung für lokale Variablen, wenn der Typ der Variablen auf der rechten Seite der Zuweisung offensichtlich ist oder wenn der genaue Typ nicht von Bedeutung ist.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());
    
  • Verwenden Sie nicht var, wenn der Typ nicht von der rechten Seite der Zuweisung offensichtlich ist.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();
    
  • Verlassen Sie sich nicht auf den Variablennamen, um den Typ der Variable anzugeben.Do not rely on the variable name to specify the type of the variable. Er ist unter Umständen nicht korrekt.It might not be correct.

    // Naming the following variable inputInt is misleading. 
    // It is a string.
    var inputInt = Console.ReadLine();
    Console.WriteLine(inputInt);
    
  • Vermeiden Sie den Einsatz von var anstelle von dynamic.Avoid the use of var in place of dynamic.

  • Verwenden Sie die implizite Typisierung, um den Typ der Schleifenvariablen in for- und foreach-Schleifen zu bestimmen.Use implicit typing to determine the type of the loop variable in for and foreach loops.

    Im folgenden Beispiel wird die implizite Typisierung in einer for-Anweisung verwendet.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);
    }
    

    Im folgenden Beispiel wird die implizite Typisierung in einer foreach-Anweisung verwendet.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();
    

Datentyp ohne VorzeichenUnsigned Data Type

  • Verwenden Sie im Allgemeinen int anstelle von Typen ohne Vorzeichen.In general, use int rather than unsigned types. Die Verwendung von int ist in C# üblich; durch den Einsatz von int wird die Interaktion mit anderen Bibliotheken vereinfacht.The use of int is common throughout C#, and it is easier to interact with other libraries when you use int.

ArraysArrays

  • Verwenden Sie die präzise Syntax, wenn Sie Arrays in der Deklarationszeile initialisieren.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.
    

DelegateDelegates

  • Verwenden Sie die präzise Syntax, um Instanzen eines Delegattyps zu erstellen.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- und using-Anweisungen in der Ausnahmebehandlungtry-catch and using Statements in Exception Handling

  • Verwenden Sie eine try-catch-Anweisung für die meisten Ausnahmebehandlungen.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;
        }
    }
    
  • Vereinfachen Sie den Code mithilfe der C#-Anweisung using.Simplify your code by using the C# using statement. Verwenden Sie bei einer try-finally-Anweisung, in der der einzige Code im finally-Block ein Aufruf der Dispose-Methode ist, stattdessen eine using-Anweisung.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;
    }
    

&&- und ||-Operatoren&& and || Operators

  • Vermeiden Sie Ausnahmen und erhöhen Sie die Leistung durch Überspringen von unnötigen Vergleichen, indem Sie && anstelle von & und || anstelle von | bei Vergleichen verwenden, wie im folgenden Beispiel gezeigt.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.");
    }
    

New-OperatorNew Operator

  • Verwenden Sie die präzise Form der Objektinstanziierung mit impliziter Typisierung, wie in der folgenden Deklaration dargestellt.Use the concise form of object instantiation, with implicit typing, as shown in the following declaration.

    var instance1 = new ExampleClass();
    

    Die vorherige Zeile entspricht der folgenden Deklaration.The previous line is equivalent to the following declaration.

    ExampleClass instance2 = new ExampleClass();
    
  • Verwenden Sie Objektinitialisierer, um die Objekterstellung zu vereinfachen.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;
    

EreignisbehandlungEvent Handling

  • Wenn Sie einen Ereignishandler definieren, den Sie später nicht entfernen müssen, verwenden Sie einen Lambda-Ausdruck.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());
    }
    

Statische MemberStatic Members

  • Rufen Sie statische Member über den Klassennamen ClassName.StaticMember auf.Call static members by using the class name: ClassName.StaticMember. Durch diese Empfehlung ist der Code besser lesbar, da der statische Zugriff eindeutig ist.This practice makes code more readable by making static access clear. Qualifizieren Sie keinen statischen Member, der in einer Basisklasse mit dem Namen einer abgeleiteten Klasse definiert ist.Do not qualify a static member defined in a base class with the name of a derived class. Während dieser Code kompiliert wird, ist die Lesbarkeit des Codes irreführend, und der Code kann später beschädigt werden, wenn Sie der abgeleiteten Klasse einen statischen Member mit dem gleichen Namen hinzufügen.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.

LINQ-AbfragenLINQ Queries

  • Verwenden Sie aussagekräftige Namen für Abfragevariablen.Use meaningful names for query variables. Im folgenden Beispiel wird seattleCustomers für Kunden in Seattle verwendet.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;
    
  • Verwenden Sie Aliase, um mithilfe der Pascal-Schreibweise sicherzustellen, dass die korrekte Großschreibung von Eigenschaftennamen anonymer Typen verwendet wird.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 };
    
  • Benennen Sie Eigenschaften um, wenn die Eigenschaftennamen im Ergebnis nicht eindeutig sind.Rename properties when the property names in the result would be ambiguous. Wenn die Abfrage beispielsweise einen Kundennamen und eine Händler-ID zurückgibt, anstatt sie als Name und ID im Ergebnis beizubehalten, benennen Sie sie um, um zu verdeutlichen, dass Name der Name eines Kunden und ID die ID eines Händlers ist.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 };
    
  • Verwenden Sie die implizierte Typisierung in der Deklaration von Abfragevariablen und Bereichsvariablen.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;
    
  • Richten Sie Abfrageklauseln unter der from-Klausel aus, wie in den vorherigen Beispielen gezeigt.Align query clauses under the from clause, as shown in the previous examples.

  • Verwenden Sie vor anderen Abfrageklauseln where-Klauseln, um sicherzustellen, dass nachfolgende Abfrageklauseln für den reduzierten, gefilterten Datensatz ausgeführt werden.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;
    
  • Verwenden Sie mehrere from-Klauseln anstelle einer join-Klausel, um auf die inneren Auflistungen zuzugreifen.Use multiple from clauses instead of a join clause to access inner collections. Eine Auflistung von Student-Objekten kann beispielsweise jeweils eine Auflistung von Testergebnissen enthalten.For example, a collection of Student objects might each contain a collection of test scores. Wenn die folgende Abfrage ausgeführt wird, wird jedes Ergebnis über 90 zusammen mit dem Nachnamen des Studenten zurückgegeben, der das Testergebnis erzielt hat.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 };
    

SicherheitSecurity

Befolgen Sie die Richtlinien in Richtlinien für das Schreiben von sicherem Code.Follow the guidelines in Secure Coding Guidelines.

Siehe auchSee Also

Visual Basic-CodierungskonventionenVisual Basic Coding Conventions
Richtlinien für das Schreiben von sicherem CodeSecure Coding Guidelines