Namenskonventionen: Richtlinien für Verben / Substantive und Englisch Grammatik Nutzung

StackOverflow https://stackoverflow.com/questions/412839

  •  03-07-2019
  •  | 
  •  

Frage

Kann mir jemand auf eine Website verweisen, oder geben Sie mir einige Weisheit, wie Sie gehen über die Namen für Schnittstellen, Klassen und vielleicht sogar Methoden und Eigenschaften in Bezug auf das, was das Objekt oder diese Methode nicht?

Auswahl Diese

ist speziell für Microsoft-Entwicklung, so Java-artige „doGet“ und so wird auf nicht wirklich benutzt, aber einige allgemeine Regeln, die Sprachbarrieren überschreiten darf (ich hätte gedacht) vorhanden sein.

Ein Beispiel könnte helfen: Ich habe 4 Auswahl von Namen für eine Schnittstelle: 

IGroupedItem
IGroupableItem
IDataEntity
IGroupedEntity

Sie alle enthalten ein Adjektiv und das Substantiv oder einfach nur ein Substantiv. Mit Blick auf die .NET-Framework es wie es scheint, muss eine Art ruleset dafür sein, für Konsistenz? Abgesehen von den offensichtlichen Verben für Methoden.

Edit: Obwohl das Beispiel eine Schnittstelle ist, ich bin nicht einschränkend nur auf Schnittstellen. Die allgemeine Richtlinie ist Klassen Substantive, Verben Methoden, Eigenschaften Substantive. Ich nehme an, was ich meine Wahl des Synonym ist. Wirft "Entity" überall falsch

War es hilfreich?

Lösung

Sehen Sie sich die MSDN Artikel für die Benennung Richtlinien. Kurz gesagt:

  • Verwenden Sie Substantive für Klassennamen und Eigenschaftsnamen (es ist offensichtlich)
  • Für Interface-Namen, mit I beginnen und verwenden Substantive und / oder Adjektive Verhalten zu beschreiben
  • Verwenden Sie Verben für Methodennamen Aktion zu beschreiben,

Für Ihr Beispiel -. IGroupableItem

Andere Tipps

Schnittstellen sind Dinge, eine Klasse ist in der Lage zu tun. Nicht das, was es ist , aber was kann es tun . 

IGroupableItem

Andere Namen beschreiben, was die Dinge sind oder sind zu vage, nützlich zu sein.

Im Einzelnen „IDataEntity“ ist weitgehend bedeutungslos. Schließlich ist alles, was eine Dateneinheit.

MSDN hat einen Artikel nur auf Schnittstelle Naming-Richtlinien das kann Ihnen helfen. Wenn Sie die Namenskonventionen von Sachen anders als Schnittstellen, zusammen mit vielen anderen Namensgebung und Design-Richtlinien möchten, können Sie, dass alle auf MSDN, finden.

Dies ist das gleiche Material wie Spodi Antwort, aber MSDN Design-Richtlinien für die Klasse Bibliothek Entwickler meist ausgezeichnet sind, abdeckt Namensgebung und viel , viel mehr.

Es ist schön Artikel machen Falscher Code Falscher Schauen von Joel Spolsky. Es erzählt nicht so beliebt, aber sehr praktisch Namenskonvention.

Neben den MSDN-Richtlinien gibt es eine C # Coding Standards Dokument von IDesign von Juval Löwy, das ist sehr hilfreich (weiß nicht, ob / wie viel dies unterscheidet sich von MSDN).

C # Coding Standards

Lizenziert unter: CC-BY-SA mit Zuschreibung
Nicht verbunden mit StackOverflow
scroll top