Capitalization Conventions

• 10/22/2008
• 2 perc olvasás
• • K
  • n
  • B
  • D
  • n
  • +10

Az ebben a fejezetben található útmutató egy egyszerű módszert határoz meg az esetek használatára, amely, következetesen alkalmazva könnyen olvashatóvá teszik a típusok, tagok és paraméterek azonosítóit.

A nagybetűs írásmód szabályai az azonosítókhoz

Az azonosítóban szereplő szavak megkülönböztetéséhez az azonosító minden szavának első betűjét írja nagybetűvel. Ne használjon aláhúzásokat a szavak megkülönböztetésére, vagy ami azt illeti, sehol az azonosítókban. Az azonosítók nagybetűs írásának két megfelelő módja van, az azonosító használatától függően:

• PascalCasing

• camelCasing

A PascalCasing konvenció, amelyet a paraméternevek kivételével minden azonosítóhoz használunk, minden szó első karakterét (beleértve a két betűnél hosszabb rövidítéseket is) nagybetűvel írja, ahogy az alábbi példákban látható:

PropertyDescriptorHtmlTag

A kétbetűs betűszavak esetében különleges eset, amelyben mindkét betű nagybetűs, amint az a következő azonosítóban látható:

IOStream

A csak a paraméternevek esetében használt camelCasing konvenció minden szó első karakterét nagybetűvel írja, kivéve az első szót, amint az a következő példákban látható. Ahogy a példa is mutatja, a camel-casinggel kezdődő kétbetűs rövidítések mindkettő kisbetűs.

propertyDescriptorioStreamhtmlTag

✔️ HASZNÁLJUK a PascalCasinget minden több szóból álló nyilvános tag-, típus- és térnévnél.

✔️ DO use camelCasing for parameter names.

A következő táblázat a különböző típusú azonosítók nagybetűs írási szabályait ismerteti.

Identifier	Casing	Example
Namespace	Pascal	namespace System.Security { ... }
Type	Pascal	public class StreamReader { ... }
Interface	Pascal	public interface IEnumerable { ... }
Method	Pascal	public class Object { public virtual string ToString(); }
Tulajdonság	Pascal	public class String { public int Length { get; } }
Egyezmény	Pascal		. public class Process { public event EventHandler Exited; }
Mező	Pascal	public class MessageQueue { public static readonly TimeSpan InfiniteTimeout; } public struct UInt32 { public const Min = 0; }
Enum value	Pascal	public enum FileMode { Append, ... }
Paraméter	Camel	public class Convert { public static int ToInt32(string value); }

Összetett szavak és általános kifejezések nagybetűzése

A legtöbb összetett kifejezést a nagybetűzés szempontjából egyszóként kell kezelni.

❌ NEM írjuk nagybetűvel az egyes szavakat az úgynevezett zárt alakú összetett szavakban.

Ezek az összetett szavak egyetlen szóval írva, mint például a végpont. A nagybetűs irányelvek alkalmazásában a zárt alakú összetett szavakat egyetlen szónak kell tekinteni. Használjon egy aktuális szótárat annak megállapításához, hogy egy összetett szó zárt alakban van-e írva.

Pascal	Camel	Nem
BitFlag	bitFlag	Bitflag
Callback	callback	CallBack
Canceled	canceled	Cancelled
DoNot	doNot	Don't
Email	email	EMail
Endpoint	endpoint	EndPoint
FileName	fileName	Filename
Gridline	gridline	GridLine
Hashtable	hashtable	HashTable
Id	id	ID
Indexes	indexes	Indices
LogOff	logOff	LogOut
LogOn	logOn	LogIn
Metadata	metadata	MetaData, metaData
Multipanel	multipanel	MultiPanel
Multiview	multiview	MultiView
Namespace	namespace	NameSpace
Ok	ok	OK
Pi	pi	PI
Placeholder	placeholder	PlaceHolder
SignIn	signIn	SignOn
SignOut	signOut	SignOff
UserName	userName	Username
WhiteSpace	whiteSpace	Whitespace
Writable	writable	Writeable

Case Sensitivity

A CLR-en futtatható nyelveknek nem kötelező támogatniuk a case-eket.érzékenységet, bár néhányan igen. Még ha az Ön nyelve támogatja is, más nyelvek, amelyek hozzáférhetnek a keretrendszeréhez, nem támogatják. A kívülről elérhető API-k ezért nem támaszkodhatnak pusztán a nagy- és kisbetűkre, hogy megkülönböztessenek két nevet ugyanabban a kontextusban.

❌ NE feltételezze, hogy minden programozási nyelv nagy- és kisbetű-érzékeny. Nem azok. A nevek nem különböztethetők meg pusztán a nagy- és kisbetűk alapján.

Tartalmak © 2005, 2009 Microsoft Corporation. Minden jog fenntartva.

A Pearson Education, Inc. engedélyével készült a Framework Design Guidelines című kiadványból: Conventions, Idioms, and Patterns for Reusable .NET Libraries, 2nd Edition by Krzysztof Cwalina and Brad Abrams, published Oct 22, 2008 by Addison-Wesley Professional as part of the Microsoft Windows Development Series.

See also

• Framework Design Guidelines
• Naming Guidelines

.