.NET Sammlung Namenskonvention

Mein Kollege und ich habe eine Diskussion darüber, welche Sammlungen genannt werden sollte.

Beispiel:

Klasse Produkt - Kollektion - Erstklassige Produkte

oder

Class-Produkt - Auflistung - Klasse ProductCollection

Ich habe einen Blick, um zu sehen, wenn ich sehen kann, irgendwelche Richtlinien oder Gründe für die Nutzung eines oder das andere, aber nichts scheint, um die Feder aus. Der Rahmen scheint beide Varianten zum Beispiel. Das argument, das ich sehen kann, ist, dass eine Klasse, die eine Sammlung von Produkten, sollten Sie die variable als "Produkte" bezeichnet, aber es sollte vom Typ ProductCollection.

Ist das so richtig wenn ja, welche?

In der gleichen Leitschaufel ist es, einen standard für die Benennung der return-variable für eine Funktion. z.B. retVal?

Wir vor allem von code in C#, obwohl ich nicht sicher bin, dass wirkt sich auf meine Frage.

InformationsquelleAutor MrEdmundo | 2009-07-14
  1. 44

    Ich würde sagen, dass mit Generika sollte es nur selten einen Grund, um eine benutzerdefinierte Sammlung geben. Aber wenn es sein muss, würde ich sagen, dass ProductCollection würde am besten passen die Namenskonventionen des Frameworks.

    Immer noch, sollten Sie erwägen, ein List<Product> oder Collection<Product> oder noch besser IList<Product> oder ICollection<Product>.

    Edit: Dies ist die Antwort auf MrEdmundo die Kommentare unten.

    In Ihrem Fall haben Sie zwei Möglichkeiten. Die offensichtliche Wahl wäre, die Vererbung verwenden, wie diese:

    class Ball { }

class BallCollection : List<Ball>
{
    public String Color { get; set; }
    public String Material { get; set; }
}

    Sage ich deutlich, weil es scheint wie die beste Idee, auf den ersten Blick, aber nach ein wenig überlegung wird es klar, dass dies nicht die beste Wahl. Was, wenn Ihnen oder von Microsoft erstellt eine neue SuperAwesomeList<T> und Sie nicht nutzen möchten, zu verbessern die Leistung Ihres BallCollection Klasse? Es würde schwierig sein, da Sie gebunden sind an die List<T> Klasse durch Vererbung und ändern Sie die Basisklasse, potenziell break-code, der verwendet BallCollection als List<T>.

    Also, was ist die bessere Lösung? Ich würde empfehlen, dass Sie in diesem Fall nicht besser wäre, zu Gunsten Zusammensetzung über Vererbung. Wie würde also eine Zusammensetzung-basierte Lösung Aussehen?

    class Ball { }

class BallCollection
{
    public String Color { get; set; }
    public String Material { get; set; }
    public IList<Ball> Balls { get; set; }
}

    Beachten Sie, dass ich erklärt haben, die Balls Eigenschaft Typ IList<T>. Dies bedeutet, dass Sie frei sind, die zum implementieren der Eigenschaft, mit welcher Art Sie wollen, so lange dieser Typ implementiert IList<T>. Dies bedeutet, dass Sie frei verwenden können ein SuperAwesomeList<T> an jedem Punkt die macht diese Art deutlich besser skalierbar und weniger schmerzhaft zu pflegen.

    • +1: Stimme voll und Ganz mit allen der oben genannten. Wenn Sie es zu tun haben, nennen es XxxCollection. Aber tun Sie es nicht, wenn Sie es vermeiden können.
    • +1 für die Verwendung von built-in collection-Typen.
    • +1 für Allgemeine Sammlung, und vergessen Sie nicht die grundlegenden IEnumerable<Produkte>
    • Danke - In diesem Fall bin ich Erben von List<T>, zu ermöglichen, einige benutzerdefinierte Eigenschaften, daher die Anforderung zu dem Namen der Kollektion.
    • Aha, ich sehe. In diesem Fall würde ich ProductCollection. Ein Wort der Vorsicht: würde Ihr problem besser gelöst werden durch Mittel der Komposition? In anderen Worten, es kann einfacher sein, zu verwalten/Waage Ihre Art, wenn Sie enthalten ein List<Product> im Gegensatz zum Erben von ihm.
    • Also Ihr sagt, ich wäre besser dran mit einem Objekt mit der Liste<Produkte> als eine Eigenschaft, als auch die benutzerdefinierten Eigenschaften, anstatt die Klasse, die erbt von der Liste mit den benutzerdefinierten Eigenschaften? Ich habe nicht geraten, warum wäre das besser skalierbar konnte Sie zeigen mich in die richtige Richtung?
    • Sichere Sache! Was sind einige der Eigenschaften, die Sie hinzufügen? Wenn Sie können, geben Sie mir eine Vorstellung von dem, was Sie versuchen zu tun, die ich Bearbeiten kann meine Antwort um ein Beispiel.
    • OK. Dies ist nicht, was ich verwende, scheint aber Sinn zu machen. Vorstellen ich habe eine Tasche, und die Tasche enthält Kugeln. Die Tasche hat Eigenschaften, Farbe und Material (string). Ich denke, ich kann sehen, was du sagen wirst. Ist es eine Entscheidung, ob die Tasche "ist" eine Sammlung von Bällen, oder ob die Bälle in der Tasche sind lediglich ein Attribut von einer Tasche?
    • Die Farbe und material des Balls-das sind Attribute, die Kugeln selbst. Als solche, Sie sammeln nicht brauchen, um über Sie wissen. Ich denke, in diesem Fall brauchen Sie nicht zu schaffen eine neue Art als List<Ball> sollte gut funktionieren.
    • Sorry, ich glaube ich muss es erklärt hast, schlecht. Die Farbe und das Material finden Sie in der Tasche. z.B. Die Blaue Tasche aus Nylon, enthält Kugeln.
    • Ich bin auch interessiert an der Antwort zu MrEdmundo neuesten Kommentar.
    • In dieser Tasche mit Bällen Fall, ich glaube, ich würde erstellen Sie eine Klasse namens " Beutel mit der Farb-und Material-Eigenschaften. Zusätzlich würde ich wahrscheinlich geben ihm eine Eigenschaft genannt, die Inhalte oder die etwas vom Typ IEnumerable<Ball - > oder IList<Ball - > oder IList<Spielzeug> oder so ähnlich.
    • Wenn ich denke, dass Sie mehr über Sie, ich wäre vielleicht machen die Tasche implementieren von IEnumerable<Spielzeug> und die Inhalt-Eigenschaft werden IList<Spielzeug> (oder swap-Spielzeug mit Ball). Ich bin kein Experte aber :p
    • Vielen Dank für Ihre Zeit. Ich Schätze die ausführliche Antwort. Ed

    InformationsquelleAutor Andrew Hare
  2. 21

    Produkte ist sicherlich nicht korrekt IMHO. Eine nicht-statische Klasse name sollte repräsentieren ein Substantiv (nicht im plural), denn Sie sollten in der Lage sein zu sagen "x ist ein [classname]".

    Offensichtlich, Produkte passt nicht in dieses Schema. ProductCollection hat:

    Illustration:

    var products = new Products(); //products is a Products

var products = new ProductCollection(); //products is a ProductCollection

    Denen man "richtig klingt" ?

    Andere Sache, über die Benennung collection-Klassen: gewöhnlich versuche ich Namen Kollektion-Klassen in einer solchen Weise, dass es klar ist, welche Art von Sammlung es ist.

    Beispiel:

    • Klasse ProductCollection: kann nur aufgezählt werden und der Graf abgerufen, D. H. nur ICollection implementiert interface(s))
    • Klasse ProductList: eine Liste, die manipuliert werden können mit Add(), Insert(), etc. (d.h. implementiert die IList-Schnittstelle(s))
    • Klasse ProductDictionary: ein Wörterbuch der Produkte zugänglich, einige der wichtigsten (d.h. implementiert IDictionary-interface(s))

    Den letzten kann man zweideutig sein, wenn es könnte ein Zweifel, was der Schlüssel des dictionary ist, so ist es besser, zu geben, was die key-Typ ist (wie ProductDictionaryByString). Aber um ehrlich zu sein, habe ich selten nennen es so, weil die meisten der Zeit, wird der Schlüssel ein string, sowieso.

    • Wäre es nicht besser zu verwenden products statt list als Variablenname in diesen Beispielen?
    • Natürlich ein guter Punkt. Im echten code wäre es viel besser, aber das ist einfach eine Abbildung von, warum der Unterricht sollte den Namen in einer bestimmten Art und Weise.
    InformationsquelleAutor Philippe Leybaert
  3. 6

    Den .NET Framework verwendet Häufig eine "Sammlung" postfix für seine Sammlung Arten. StringCollection, ObservableCollection, KeyedCollection, etc. So gehen Sie mit ProductCollection.

    InformationsquelleAutor Randolpho
  4. 5

    Bemerkt niemand beantwortet Sie auf der retVal-Zeug (Oder ich konnte einfach immer blind). Ich bin zwar kein Experte; auf die Frage der retVal Problem ich bin mir nicht 100% sicher was du meinst mit "naming -, Rückgabe-variable", aber wenn du meinst Sachen wie diese:

    public void GetSomething(out object retVal) 
{
    retVal = ThingFactory.CreateSomething();
}

    Ich würde sagen, egal, was die Konvention ist, tun Sie es nicht. Es ist sehr ärgerlich. Nur den Rückgabewert statt. Wenn Sie brauchen, um wieder mehr als eine Sache, dann ich denken würde, dass die Methode entweder nicht mehr als eine Sache (die Methode sollte nicht) oder diese Dinge sollten eingepackt werden in eine Art von logischer Klasse, die zurückgegeben werden, statt.

    Wenn anstelle von "naming -, Rückgabe-variable" meinst du Sachen wie diese:

    var retVal = ThingFactory.CreateSomething();

    Dann würde ich sagen, dem Namen der variable nach dem, was es ist. Was es wird für verwendet werden. Wenn Ihr eine Liste der Autos, nennen es listOfCars, wenn es ein Stück Brot gegessen werden, später nennen Sie es pieceOfBread oder pieceOfBreadToBeEatenLater.

    Hoffe, dass geholfen, und, dass es nicht zu weit Weg in ein Feld irgendwo :p

    InformationsquelleAutor Svish
  5. 2

    Thesaurus.com

    Suchen Sie nicht weiter. Nicht mehr werden Sie mull über pluralisiert Singularität. Einfach befestigen Sie eine der diese plural-Protektoren an Ihrem Objekt name:

    • Durcheinander
    • Gob
    • Fundgrube
    • Sonstiges
    • Vocab
    • Laden
    • Agglomeration
    • Hügel
    • Serie
    • Lexikon
    • Aufbringen
    • Glossar
    • Hort
    • Schwarm
    • Gruppe
    • Cluster
    • Konvoi
    • Assemblage
    • Herde
    • Mob
    • Batch
    • Häufung
    • Haufen
    • Bank
    • Gemeinde
    • Klumpen
    • Volumen
    • Set
    • Reserve
    • Zusammenstellung
    • Herde
    • Armee

    Machen Spaß.

    InformationsquelleAutor Tyler Pantuso
Schreibe einen Kommentar