Konvence používání velkých písmen

Poznámka:

Tento obsah je znovu vytištěn oprávněním Pearson Education, Inc. z Framework Design Guidelines: Conventions, Idioms a Patterns for Reusable .NET Libraries, 2. vydání. Tato edice byla publikována v roce 2008 a kniha byla od té doby plně upravena ve třetím vydání. Některé informace na této stránce můžou být zastaralé.

Pokyny v této kapitole obsahují jednoduchou metodu použití případu, která při použití konzistentně usnadňují čtení identifikátorů pro typy, členy a parametry.

Pravidla pro velká písmena u identifikátorů.

Chcete-li rozlišovat slova v identifikátoru, napište první písmeno každého slova velkým písmenem. Nepoužívejte podtržítka k rozlišení slov, a to ani kdekoli v identifikátorech. Existují dva vhodné způsoby, jak psát identifikátory velkými písmeny, v závislosti na použití identifikátoru:

  • PascalCasing

  • camelCasing

Konvence PascalCasing, která se používá pro všechny identifikátory s výjimkou názvů parametrů, používá velké písmeno na začátku každého slova (včetně akronymů, které jsou delší než dvě písmena), jak je znázorněno v následujících příkladech:

PropertyDescriptor HtmlTag

Speciální případ se skládá ze dvoupísmenných zkratek, ve kterých jsou obě písmena velká, jak je znázorněno v následujícím identifikátoru:

IOStream

Konvence camelCasing, která se používá pouze pro názvy parametrů, kapitalizuje první písmeno každého slova s výjimkou prvního slova, jak je uvedeno v následujících příkladech. Jak ukazuje příklad také dvoupísmenné zkratky, které začínají velbloudím identifikátorem, jsou malá písmena.

propertyDescriptor ioStream htmlTag

✔️ DO použijte PascalCasing pro všechny veřejné členy, typy a názvy jmenných prostorů skládající se z více slov.

✔️ Používejte camelCasing pro názvy parametrů.

Následující tabulka popisuje pravidla používání velkých písmen pro různé typy identifikátorů.

Identifikátor Velká/malá písmena Příklad
Namespace Pascal namespace System.Security { ... }
Typ Pascal public class StreamReader { ... }
Rozhraní Pascal public interface IEnumerable { ... }
Metoda Pascal public class Object {
public virtual string ToString();
}
Vlastnictví Pascal public class String {
public int Length { get; }
}
Událost Pascal public class Process {
public event EventHandler Exited;
}
Obor Pascal public class MessageQueue {
public static readonly TimeSpan
InfiniteTimeout;
}
public struct UInt32 {
public const Min = 0;
}
Hodnota výčtu Pascal public enum FileMode {
Append,
...
}
Parametr Velbloud public class Convert {
public static int ToInt32(string value);
}

Velká písmena pro složená slova a běžné termíny

Většina složených termínů se pro účely kapitalizace považuje za jednotlivá slova.

❌ NEPOUŽÍVEJTE velká písmena každého slova v takzvaných složených slovech s uzavřeným tvarem.

Jedná se o složená slova napsaná jako jedno slovo, například koncový bod. Pro účely pokynů pro vkládání textu zacházejte s uzavřeným složeným slovem jako s jedním slovem. Pomocí aktuálního slovníku určete, jestli je složené slovo napsané v uzavřené podobě.

Pascal Velbloud Ne
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

Citlivost na velikost písmen

Jazyky, které mohou běžet na CLR, nejsou povinné podporovat rozlišování velkých a malých písmen, i když některé ji podporují. I když ho váš jazyk podporuje, jiné jazyky, které by mohly přistupovat k vaší platformě, ne. Všechna rozhraní API, která jsou externě přístupná, proto se při rozlišování dvou názvů ve stejném kontextu nemůžou spoléhat pouze na malá a velká písmena.

❌ NEPŘEDPOKLÁDEJTE, že všechny programovací jazyky rozlišují malá a velká písmena. Nejsou. Názvy se nemohou lišit pouze velikostí písmen.

Části z © 2005, 2009 Microsoft Corporation. Všechna práva vyhrazena.

Přetištěno se svolením Pearson Education, Inc. z Framework Design Guidelines: Conventions, Idioms, and Patterns for Reusable .NET Libraries, 2nd Edition od Krzysztofa Cwaliny a Brada Abramse, vydáno 22. října 2008 nakladatelstvím Addison-Wesley Professional jako součást série Microsoft Windows Development.

Viz také

  • Last updated on