Megosztás a következőn keresztül:

Típustagok nevei

  • Cikk

Feljegyzés

Ezt a tartalmat a Pearson Education, Inc. engedélyével nyomtatjuk újra a Framework Design Guidelines: Conventions, Idioms és Patterns for Reusable .NET Libraries, 2nd Edition engedélyével. Ezt a kiadást 2008-ban adták ki, és a könyvet azóta teljesen átdolgozták a harmadik kiadásban. Előfordulhat, hogy az oldalon található információk némelyike elavult.

A típusok tagokból állnak: metódusokból, tulajdonságokból, eseményekből, konstruktorokból és mezőkből. A következő szakaszok a típustagok elnevezésére vonatkozó irányelveket ismertetik.

Metódusok nevei

Mivel a metódusok a művelet végrehajtásának eszközei, a tervezési irányelvek megkövetelik, hogy a metódusnevek igék vagy igekifejezések legyenek. Az útmutatót követve megkülönböztetheti a metódusneveket a tulajdonság- és típusnevektől, amelyek főnévi vagy melléknévi kifejezések.

✔️ A DO olyan metódusneveket ad meg, amelyek igék vagy igekifejezések.

public class String {
    public int CompareTo(...);
    public string[] Split(...);
    public string Trim();
}

Tulajdonságok nevei

A többi tagtól eltérően a tulajdonságoknak főnévi kifejezést vagy mellékneveket kell adni. Ennek az az oka, hogy egy tulajdonság az adatokra hivatkozik, és a tulajdonság neve ezt tükrözi. A PascalCasing mindig a tulajdonságnevekhez használatos.

✔️ DO névtulajdonságok főnév, főnévi kifejezés vagy melléknév használatával.

❌ NE rendelkezzen olyan tulajdonságokkal, amelyek megfelelnek a "Get" metódusok nevének, mint az alábbi példában:

public string TextWriter { get {...} set {...} } public string GetTextWriter(int value) { ... }

Ez a minta általában azt jelzi, hogy a tulajdonságnak valóban metódusnak kell lennie.

✔️ DO névgyűjtemény-tulajdonságok többes számú kifejezéssel, amelyek a gyűjtemény elemeit írják le, nem pedig egy egyedi kifejezést, majd a "Lista" vagy a "Gyűjtemény" kifejezést.

✔️ DO name Boolean properties with an affirmative phrase (CanSeek ahelyett CantSeek). A logikai tulajdonságok előtagja lehet "Is", "Can" vagy "Has" is, de csak ott, ahol értéket ad hozzá.

✔️ FONTOLJA meg, hogy egy tulajdonság neve megegyezik a típusával.

A következő tulajdonság például helyesen kap és állít be egy névvel ellátott Colorenumerálási értéket, így a tulajdonság neve Color:

public enum Color {...}
public class Control {
    public Color Color { get {...} set {...} }
}

Események nevei

Az események mindig valamilyen műveletre utalnak, vagy az egyikre, amely éppen történik, vagy egy olyanra, amely megtörtént. Ezért a metódusokhoz hasonlóan az eseményeket igékkel nevezik el, az igeidő pedig az esemény keletkezésének időpontját jelzi.

✔️ Do name events with a verb or a verb phrase.

Ilyenek például Clickeda következők: , Painting, DroppedDownstb.

✔️ A DO a jelen és az elmúlt eszmék használatával adja meg az események nevét az előtt és után fogalommal.

Például egy ablak bezárása előtt felhozott bezárt eseményt hívnánk Closingmeg, és az ablak bezárása után emelt eseményt hívnánk meg Closed.

❌ NE használjon "Előtte" vagy "After" előtagot vagy utótagot az események előtti és utáni események jelzéséhez. Használja a jelenlegi és az elmúlt tízeseket az imént ismertetett módon.

✔️ DO-név eseménykezelők (eseménytípusokként használt meghatalmazottak) az "EventHandler" utótaggal, ahogyan az alábbi példában látható:

public delegate void ClickedEventHandler(object sender, ClickedEventArgs e);

✔️ A DO két, elnevezett sender paramétert e használ az eseménykezelőkben.

A feladó paraméter az eseményt okozó objektumot jelöli. A küldő paraméter általában típus object, még akkor is, ha egy konkrétabb típust lehet alkalmazni.

✔️ DO név eseményargumentumosztályok az "EventArgs" utótaggal.

Mezők nevei

A mezőelnevezési irányelvek a statikus nyilvános és védett mezőkre vonatkoznak. A belső és a privát mezőkre nem vonatkoznak irányelvek, és a tagok tervezési irányelvei nem engedélyezik a nyilvános vagy védett példányok mezőit.

✔️ A DO a PascalCasing parancsot használja a mezőnevekben.

✔️ DO névmezők főnévvel, főnévvel vagy melléknévvel.

❌ NE használjon előtagot a mezőnevekhez.

Például ne használjon "g_" vagy "s_" statikus mezőket.

© Részletek 2005, 2009 Microsoft Corporation. Minden jog fenntartva.

Reprinted by permission of Pearson Education, Inc. from Framework Design Guidelines: Conventions, Idioms and Patterns for Reusable .NET Libraries, 2nd Edition by Krzysztof Cwalina and Brad Abrams, published 22, 2008 by Addison-Wesley Professional, a Microsoft Windows Development Series részeként.

Lásd még