Kapitalizační konvence

• 10/22/2008
• 2 minuty čtení
• • K
  • n
  • B
  • D
  • n
  • +10

Pokyny v této kapitole stanoví jednoduchou metodu použití případu, který, při důsledném použití usnadňují čtení identifikátorů typů, členů a parametrů.

Pravidla pro psaní velkých písmen v identifikátorech

Pro odlišení slov v identifikátoru pište první písmeno každého slova v identifikátoru velkým písmenem. Nepoužívejte podtržítka k odlišení slov, a ostatně ani nikde jinde v identifikátorech. V závislosti na použití identifikátoru existují dva vhodné způsoby psaní velkých písmen v identifikátorech:

• PascalCasing

• camelCasing

Konvence PascalCasing, používaná pro všechny identifikátory kromě názvů parametrů, píše první znak každého slova (včetně zkratek delších než dvě písmena) velkým písmenem, jak je uvedeno v následujících příkladech:

PropertyDescriptorHtmlTag

Speciální případ je pro dvoupísmenné zkratky, v nichž jsou obě písmena velká, jak je uvedeno v následujících identifikátorech:

IOStream

Konvence camelCasing, používaná pouze pro názvy parametrů, píše první znak každého slova kromě prvního slova, jak je uvedeno v následujících příkladech. Jak příklad také ukazuje, dvoupísmenné zkratky, které začínají identifikátor s velbloudím písmem, se píší obě malými písmeny.

propertyDescriptorioStreamhtmlTag

✔️Používejte PascalCasing pro všechny veřejné názvy členů, typů a jmenných prostorů složené z více slov.

✔️ PRO názvy parametrů používejte camelCasing.

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

.

Identifikátor	Popisování	Příklad
Jmenný prostor	Pascal	namespace System.Security { ... }
Type	Pascal	public class StreamReader { ... }
Interface	Pascal	public interface IEnumerable { ... }
Metoda	Pascal	public class Object { public virtual string ToString(); }
Vlastnost	Pascal	public class String { public int Length { get; } }
Událost	Pascal	public class Process { public event EventHandler Exited; }
Field	Pascal	public class MessageQueue { public static readonly TimeSpan InfiniteTimeout; } public struct UInt32 { public const Min = 0; }
Enum value	Pascal	public enum FileMode { Append, ... }
Parametr	Kamel	public class Convert { public static int ToInt32(string value); }

Většina složených výrazů se pro účely psaní velkých písmen považuje za jednotlivá slova.

❌ NELZE psát s velkým písmenem každé slovo v tzv. uzavřených složených slovech.

Jedná se o složená slova psaná jako jedno slovo, například koncový bod. Pro účely pokynů pro psaní velkých písmen považujte složené slovo v uzavřeném tvaru za slovo jediné. K určení, zda je složené slovo zapsáno v uzavřeném tvaru, použijte aktuální slovník.

.

Pascal	Camel	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

Case Sensitivity

Jazyky, které mohou běžet na CLR, nemusí podporovat velikost písmen.citlivost písmen, ačkoli některé ano. I když ji váš jazyk podporuje, jiné jazyky, které mohou přistupovat k vašemu frameworku, ji nepodporují. Jakákoli rozhraní API, která jsou přístupná zvenčí, se proto nemohou spoléhat pouze na rozlišování velkých a malých písmen u dvou jmen ve stejném kontextu.

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

Portions © 2005, 2009 Microsoft Corporation. Všechna práva vyhrazena.

Přetištěno se svolením společnosti Pearson Education, Inc. z publikace Framework Design Guidelines:

Viz také

• Framework Design Guidelines
• Naming Guidelines

.