Richtlinien für die Benennung von Eigenschaften

Die folgenden Regeln dienen als Richtlinie für die Benennung von Eigenschaften:

  • Verwenden Sie ein Substantiv oder einen substantivischen Ausdruck, um eine Eigenschaft zu benennen.
  • Verwenden Sie die Pascal-Schreibweise.
  • Verwenden Sie nicht die ungarische Notation.
  • Es empfiehlt sich u. U., eine Eigenschaft mit dem gleichen Namen zu benennen wie der zugrunde liegende Typ. Wenn Sie beispielsweise eine Eigenschaft mit dem Namen Color deklarieren, sollte der Typ der Eigenschaft ebenfalls Color sein. Siehe das Beispiel weiter unten in diesem Thema.

Das folgende Codebeispiel veranschaulicht die korrekte Benennung von Eigenschaften.

Public Class SampleClass 
   Public Property BackColor As Color
      ' Code for Get and Set accessors goes here.
   End Property
End Class
[C#]
public class SampleClass
{
   public Color BackColor 
   {
      // Code for Get and Set accessors goes here.
   }
}

Das folgende Codebeispiel veranschaulicht die Bereitstellung einer Eigenschaft mit dem gleichen Namen wie ein Typ.

Public Enum Color 
   ' Insert code for Enum here. 
End Enum
Public Class Control 
   Public Property Color As Color
      Get
         ' Insert code here.
      End Get 
      Set
         ' Insert code here.
      End Set
   End Property
End Class
[C#]
public enum Color 
{
   // Insert code for Enum here.
}
public class Control 
{
   public Color Color 
   { 
      get {// Insert code here.} 
      set {// Insert code here.} 
   }
}

Das folgende Codebeispiel ist falsch, da die Color-Eigenschaft vom Typ Integer ist.

Public Enum Color 
   ' Insert code for Enum here. 
End Enum
Public Class Control 
   Public Property Color As Integer
      Get
         ' Insert code here.
      End Get 
      Set
         ' Insert code here.
      End Set
   End Property
End Class
[C#]
public enum Color {// Insert code for Enum here.}
public class Control 
{
   public int Color 
   { 
      get {// Insert code here.} 
      set {// Insert code here.}  
   }
}

In dem Beispiel mit der falschen Benennung kann nicht auf die Member der Color-Enumeration verwiesen werden. Color.Xxx wird so interpretiert, als ob es auf einen Member zugreift, der zuerst den Wert der Color-Eigenschaft (Typ Integer in Visual Basic oder Typ int in C#) abruft und dann auf einen Member dieses Wertes zugreift (der ein Instanzenmember von System.Int32 sein müsste).

Siehe auch

Entwurfsrichtlinien für die Entwicklung von Klassenbibliotheken | Richtlinien für die Verwendung von Eigenschaften