C# のコーディング規則 (C# プログラミング ガイド)C# Coding Conventions (C# Programming Guide)

C# 言語仕様では、コーディング標準は定義されていません。The C# Language Specification does not define a coding standard. ただし、このトピックのガイドラインは、サンプルおよびドキュメントを開発するためにマイクロソフトによって使用されます。However, the guidelines in this topic are used by Microsoft to develop samples and documentation.

コーディング規則には、次の目的があります。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.

名前付け規則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. 次の例に示すように、修飾名が長すぎて 1 行に収まらない場合は、ドット (.) の後で改行できます。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:

  • コード エディターの既定の設定 (スマート インデント、4 文字インデント、タブを空白として保存) を使用します。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.

  • 1 つの行には 1 つのステートメントのみを記述します。Write only one statement per line.

  • 1 つの行には 1 つの宣言のみを記述します。Write only one declaration per line.

  • 継続行にインデントが自動的に設定されない場合は、1 タブ ストップ (4 つの空白) 分のインデントを設定します。If continuation lines are not indented automatically, indent them one tab stop (four spaces).

  • メソッド定義とプロパティ定義の間に少なくとも 1 行の空白行を追加します。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.

  • 次の例に示すように、コメント デリミター (//) とコメント テキストの間に空白を 1 つ挿入します。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.

文字列型 (String)String Data Type

  • 次のコードに示すように、短い文字列を連結するときは + 演算子を使用します。Use the + operator 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);
    
  • dynamic の代わりに var を使用しないようにしてください。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 データ型Unsigned Data Type

  • 通常は、unsigned 型ではなく 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.");
    }
    

new 演算子New 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.

LINQ クエリLINQ 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. たとえば、クエリで顧客名と販売店 ID を返す場合、クエリ結果で NameID をそのまま使用するのではなく、これらの名前を変更し、Name が顧客の名前であり、ID が販売店の 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;
    
  • 内部コレクションにアクセスするには、join 句ではなく複数の from 句を使用します。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

Visual Basic のコーディング規則Visual Basic Coding Conventions
安全なコーディングのガイドラインSecure Coding Guidelines