Richtlinien für die Benennung von Parametern
Halten Sie diese Richtlinien für die Benennung von Parametern streng ein, da visuelle Entwurfstools, die kontextbezogene Hilfe bereitstellen und das Durchsuchen von Klassen ermöglichen, dem Benutzer im Designer die Parameternamen von Methoden anzeigen. Die folgenden Regeln dienen als Richtlinie für die Benennung von Parametern:
- Verwenden Sie für Parameternamen die Kamel-Schreibweise.
- Verwenden Sie beschreibende Parameternamen. Parameternamen sollten so aussagekräftig sein, dass anhand des Namens und des Typs des Parameters in den meisten Situationen festgestellt werden kann, welche Bedeutung der Parameter hat. Beispielsweise zeigen visuelle Entwurfstools, die kontextbezogene Hilfe bereitstellen, dem Benutzer während der Eingabe Methodenparameter an. Die Parameternamen sollten in diesem Szenario so aussagekräftig sein, dass der Entwickler die richtigen Parameter angeben kann.
- Verwenden Sie Namen, die die Bedeutung eines Parameters beschreiben, und nicht Namen, die dessen Typ beschreiben. Ein Entwicklungstool sollte ausreichende Informationen über den Typ eines Parameters bereitstellen. Deshalb leistet der Name eines Parameters bessere Dienste, wenn er die Bedeutung des Parameters wiedergibt. Verwenden Sie typbasierte Parameternamen sparsam und nur, falls erforderlich.
- Verwenden Sie keine reservierten Parameter. Reservierte Parameter sind private Parameter, die in einer zukünftigen Version offengelegt werden können, wenn sie benötigt werden. Falls also in einer zukünftigen Version Ihrer Klassenbibliothek mehr Daten benötigt werden, fügen Sie eine neue Überladung für eine Methode hinzu.
- Stellen Sie Parameternamen kein Präfix in der ungarischen Notation voran.
Im Folgenden einige Beispiele für korrekt benannte Parameter.
GetType(typeName As String)As Type
Format(format As String, args() As object)As String
[C#]
Type GetType(string typeName)
string Format(string format, object[] args)
Siehe auch
Entwurfsrichtlinien für die Entwicklung von Klassenbibliotheken | Richtlinien für die Verwendung von Parametern