部分クラスと部分メソッド (C# プログラミング ガイド)Partial Classes and Methods (C# Programming Guide)

クラス構造体インターフェイスやメソッドの定義を複数のソース ファイルに分割できます。It is possible to split the definition of a class, a struct, an interface or a method over two or more source files. 各ソース ファイルには型やメソッドの定義のセクションが含まれ、分割されたすべての部分はアプリケーションのコンパイル時に結合されます。Each source file contains a section of the type or method definition, and all parts are combined when the application is compiled.

部分クラスPartial Classes

クラス定義を分割するのが望ましいのは、次のような場合です。There are several situations when splitting a class definition is desirable:

  • 大型プロジェクトを開発する際にクラスを別個のファイルに分割すると、複数のプログラマーが同時にそのクラスの作業を行うことができます。When working on large projects, spreading a class over separate files enables multiple programmers to work on it at the same time.

  • 自動的に生成されたソースを使用する場合、ソース ファイルを再作成することなく、コードをクラスに追加できます。When working with automatically generated source, code can be added to the class without having to recreate the source file. Visual Studio では、Windows フォームや Web サービス ラッパー コードなどを作成するときにこのアプローチを使用します。Visual Studio uses this approach when it creates Windows Forms, Web service wrapper code, and so on. Visual Studio によって作成されたファイルを変更せずに、これらのクラスを使用するコードを作成できます。You can create code that uses these classes without having to modify the file created by Visual Studio.

  • クラス定義を分割するには、次のように partial キーワード修飾子を使用します。To split a class definition, use the partial keyword modifier, as shown here:

    public partial class Employee
    {
        public void DoWork()
        {
        }
    }
    
    public partial class Employee
    {
        public void GoToLunch()
        {
        }
    }
    

partial キーワードは、クラス、構造体、またはインターフェイスの他の部分を名前空間内で定義できることを示します。The partial keyword indicates that other parts of the class, struct, or interface can be defined in the namespace. partial キーワードは、すべての部分で使用する必要があります。All the parts must use the partial keyword. 最終的な型を形成するためには、コンパイル時にすべての部分が利用可能である必要があります。All the parts must be available at compile time to form the final type. また、すべての部分で同じアクセシビリティ (publicprivate など) を使用する必要があります。All the parts must have the same accessibility, such as public, private, and so on.

abstract と宣言された部分がある場合、型全体が抽象と見なされます。If any part is declared abstract, then the whole type is considered abstract. sealed と宣言された部分がある場合、型全体が sealed と見なされます。If any part is declared sealed, then the whole type is considered sealed. また、基本データ型を宣言する部分がある場合は、型全体が該当するクラスを継承します。If any part declares a base type, then the whole type inherits that class.

基底クラスを指定する部分はすべて一致する必要がありますが、基底クラスを省略する部分も基本データ型を継承します。All the parts that specify a base class must agree, but parts that omit a base class still inherit the base type. 部分は別の基本インターフェイスを指定でき、すべての部分宣言で示されたすべてのインターフェイスが最終的な型によって実装されます。Parts can specify different base interfaces, and the final type implements all the interfaces listed by all the partial declarations. 部分定義で宣言されたクラス、構造体、インターフェイスの各メンバーは、他のすべての部分で利用できます。Any class, struct, or interface members declared in a partial definition are available to all the other parts. 最終的な型は、コンパイル時にすべての部分を結合して形成されます。The final type is the combination of all the parts at compile time.

注意

partial 識別子は、デリゲートや列挙宣言では使用できません。The partial modifier is not available on delegate or enumeration declarations.

次の例は、入れ子にされた型は、それを包含する型自体が partial でない場合でも、partial にできることを示しています。The following example shows that nested types can be partial, even if the type they are nested within is not partial itself.

class Container
{
    partial class Nested
    {
        void Test() { }
    }
    partial class Nested
    {
        void Test2() { }
    }
}

部分型定義の属性は、コンパイル時に結合されます。At compile time, attributes of partial-type definitions are merged. たとえば、次のような宣言があるとします。For example, consider the following declarations:

[SerializableAttribute]
partial class Moon { }

[ObsoleteAttribute]
partial class Moon { }

これらは、次の宣言と等価です。They are equivalent to the following declarations:

[SerializableAttribute]
[ObsoleteAttribute]
class Moon { }

各部分型定義に含まれる次の要素は、すべて結合されます。The following are merged from all the partial-type definitions:

  • XML コメントXML comments

  • インターフェイスinterfaces

  • ジェネリック型パラメーター属性generic-type parameter attributes

  • クラス属性class attributes

  • メンバーmembers

たとえば、次のような宣言があるとします。For example, consider the following declarations:

partial class Earth : Planet, IRotate { }
partial class Earth : IRevolve { }

これらは、次の宣言と等価です。They are equivalent to the following declarations:

class Earth : Planet, IRotate, IRevolve { }

制約Restrictions

部分クラス定義を使用する場合は、いくつかの規則に従う必要があります。There are several rules to follow when you are working with partial class definitions:

  • 同じ型の部分である部分型定義はすべて partial で修飾する必要があります。All partial-type definitions meant to be parts of the same type must be modified with partial. たとえば、次のクラス宣言はエラーになります。For example, the following class declarations generate an error:

    public partial class A { }
    //public class A { }  // Error, must also be marked partial
    
  • partial 修飾子は、classstruct、または interface キーワードの直前にのみ配置できます。The partial modifier can only appear immediately before the keywords class, struct, or interface.

  • 入れ子にされた部分型は、次の例に示すように、部分型定義で宣言できます。Nested partial types are allowed in partial-type definitions as illustrated in the following example:

    partial class ClassWithNestedClass
    {
        partial class NestedClass { }
    }
    
    partial class ClassWithNestedClass
    {
        partial class NestedClass { }
    }
    
  • 同じ型の部分である部分型定義は、すべて同じアセンブリおよび同じモジュール (.exe ファイルまたは .dll ファイル) 内で定義する必要があります。All partial-type definitions meant to be parts of the same type must be defined in the same assembly and the same module (.exe or .dll file). 部分定義は、複数のモジュールにまたがることができません。Partial definitions cannot span multiple modules.

  • クラス名とジェネリック型パラメーターはすべての部分型定義で一致する必要があります。The class name and generic-type parameters must match on all partial-type definitions. ジェネリック型は partial にできます。Generic types can be partial. それぞれの部分宣言では、同じパラメーター名を同じ順序で使用する必要があります。Each partial declaration must use the same parameter names in the same order.

  • 以下のキーワードは、部分型定義では省略できますが、ある 1 つの部分型定義に存在する場合は、同じ型の別の部分定義で指定されているキーワードと競合できません。The following keywords on a partial-type definition are optional, but if present on one partial-type definition, cannot conflict with the keywords specified on another partial definition for the same type:

詳細については、「型パラメーターの制約」を参照してください。For more information, see Constraints on Type Parameters.

例 1Example 1

説明Description

次の例では、クラス Coords のフィールドとコンストラクターを 1 つの部分クラス定義で宣言し、メンバー PrintCoords を別の部分クラス定義で宣言しています。In the following example, the fields and the constructor of the class, Coords, are declared in one partial class definition, and the member, PrintCoords, is declared in another partial class definition.

コードCode

public partial class Coords
{
    private int x;
    private int y;

    public Coords(int x, int y)
    {
        this.x = x;
        this.y = y;
    }
}

public partial class Coords
{
    public void PrintCoords()
    {
        Console.WriteLine("Coords: {0},{1}", x, y);
    }

}

class TestCoords
{
    static void Main()
    {
        Coords myCoords = new Coords(10, 15);
        myCoords.PrintCoords();

        // Keep the console window open in debug mode.
        Console.WriteLine("Press any key to exit.");
        Console.ReadKey();
    }
}
// Output: Coords: 10,15

例 2Example 2

説明Description

次の例は、部分構造体と部分インターフェイスも開発できることを示しています。The following example shows that you can also develop partial structs and interfaces.

コードCode

partial interface ITest
{
    void Interface_Test();
}

partial interface ITest
{
    void Interface_Test2();
}

partial struct S1
{
    void Struct_Test() { }
}

partial struct S1
{
    void Struct_Test2() { }
}

部分メソッドPartial Methods

部分クラスまたは構造体には部分メソッドを含めることができます。A partial class or struct may contain a partial method. クラスのある部分に、メソッドのシグネチャが含まれます。One part of the class contains the signature of the method. 同じ部分または別の部分に、オプションの実装を定義できます。An optional implementation may be defined in the same part or another part. 実装が指定されていない場合、メソッドとメソッドに対するすべての呼び出しは、コンパイル時に削除されます。If the implementation is not supplied, then the method and all calls to the method are removed at compile time.

部分メソッドを使用すると、イベントと同様に、クラスのある部分の実装者がメソッドを定義できます。Partial methods enable the implementer of one part of a class to define a method, similar to an event. クラスの別の部分の実装者は、メソッドを実装するかどうかを決定できます。The implementer of the other part of the class can decide whether to implement the method or not. メソッドが実装されない場合、コンパイラは、メソッド シグネチャとメソッドに対するすべての呼び出しを削除します。If the method is not implemented, then the compiler removes the method signature and all calls to the method. このメソッドの呼び出しは、呼び出しの引数の評価から発生するすべての結果を含め、実行時に影響を及ぼしません。The calls to the method, including any results that would occur from evaluation of arguments in the calls, have no effect at run time. そのため、実装が指定されていない場合でも、部分クラス内のすべてのコードで部分メソッドを自由に使用できます。Therefore, any code in the partial class can freely use a partial method, even if the implementation is not supplied. 実装されていないメソッドが呼び出された場合、コンパイル時エラーまたは実行時エラーにはなりません。No compile-time or run-time errors will result if the method is called but not implemented.

部分メソッドは、生成されるコードをカスタマイズする方法として特に便利です。Partial methods are especially useful as a way to customize generated code. メソッドの名前とシグネチャを予約できるため、生成されるコードでメソッドを呼び出すことができます。ただし、メソッドを実装するかどうかは開発者が決定できます。They allow for a method name and signature to be reserved, so that generated code can call the method but the developer can decide whether to implement the method. 部分クラスと同様に、部分メソッドでも、コード ジェネレーターによって作成されたコードと人間である開発者によって作成されたコードを実行時コストなしで連携させることができます。Much like partial classes, partial methods enable code created by a code generator and code created by a human developer to work together without run-time costs.

部分メソッドの宣言は、定義と実装の 2 つの部分から成ります。A partial method declaration consists of two parts: the definition, and the implementation. これらは部分クラスの別々の部分にあっても同じ部分にあってもかまいません。These may be in separate parts of a partial class, or in the same part. 実装宣言がない場合は、定義宣言とメソッドに対するすべての呼び出しの両方が、コンパイラによる最適化によって除外されます。If there is no implementation declaration, then the compiler optimizes away both the defining declaration and all calls to the method.

// Definition in file1.cs
partial void onNameChanged();

// Implementation in file2.cs
partial void onNameChanged()
{
  // method body
}
  • 部分メソッドの宣言はコンテキスト キーワード partial で始まる必要があり、メソッドは void を返す必要があります。Partial method declarations must begin with the contextual keyword partial and the method must return void.

  • 部分メソッドには、inref パラメーターを使用できますが、out パラメーターは使用できません。Partial methods can have in or ref but not out parameters.

  • 部分メソッドは暗黙的に private です。したがって部分メソッドを virtual にすることはできません。Partial methods are implicitly private, and therefore they cannot be virtual.

  • 部分メソッドを extern にすることはできません。部分メソッドの定義なのか実装なのかは、本体の存在で決まるためです。Partial methods cannot be extern, because the presence of the body determines whether they are defining or implementing.

  • 部分メソッドには static 修飾子と unsafe 修飾子を使用できます。Partial methods can have static and unsafe modifiers.

  • 部分メソッドはジェネリックにできます。Partial methods can be generic. 制約は部分メソッドの定義宣言に置き、必要に応じて実装宣言で繰り返すことができます。Constraints are put on the defining partial method declaration, and may optionally be repeated on the implementing one. パラメーター名と型パラメーター名は、定義宣言と実装宣言で同じである必要はありません。Parameter and type parameter names do not have to be the same in the implementing declaration as in the defining one.

  • delegate は、定義および実装されている部分メソッドには使用できますが、定義されているのみの部分メソッドには使用できません。You can make a delegate to a partial method that has been defined and implemented, but not to a partial method that has only been defined.

C# 言語仕様C# Language Specification

詳細については、「C# 言語仕様」の部分型に関するセクションを参照してください。For more information, see Partial types in the C# Language Specification. 言語仕様は、C# の構文と使用法に関する信頼性のある情報源です。The language specification is the definitive source for C# syntax and usage.

関連項目See also