Popis konvencí názvů
- Velká a malá písmena v názvech Existují dva základní způsoby zápisu: Pascal case a Camel case. Pascal case je způsob zápisu známý z jazyka Pascal. Spočívá v použití velkého písmena v prvním a každém dalším slově názvu, např. BeginInvoke, GetFileName, atd. Camel case spočívá v použití malého písmena v prvním a velkého písmena v každém dalším slově názvu, např. customerOrders, tempFileName, atd.
Názvy pouze s velkými písmeny je doporučeno používat pouze ve zkratkách, příkladem budiž System.IO nebo WebUI.
-
Maximální doporučená délka názvu Z důvodu dobré čitelnosti by název neměl přesahovat délku přibližně 20 znaků.
-
Volba názvu Při volbě názvu se snažte co nejlépe vystihnout účel. Vyvarujte se stejných názvů, jako jsou jmenné prostory v .NET Frameworku (System, Collections, atd.). Vyvarujte se stejných názvů jako jsou klíčová slova v daném jazyce . Sice to lze (proměnnou můžete pojmenovat např. [String] s použitím hranatých závorek) ale silně se to nedoporučuje.
-
Doporučené pojmenování programových elementů
4.1 Třídy K pojmenování použijte podstatné jméno. Použijte Pascal case. Zkratky používejte s rozvahou. Nepoužívejte předpony (předpona C před názvem třídy, např. CCustomer) Nepoužívejte podtržítko (_).
4.2 Rozhraní K pojmenování použijte podstatné jméno nebo přídavné jméno vyjadřující chování (např. IDisposable). Použijte Pascal case. Zkratky používejte s rozvahou. Použijte předponu I. Nepoužívejte podtržítko (_).
4.3 Atributy Použijte Pascal case. Zkratky používejte s rozvahou. Za názvem použijte příponu Attribute (např. ObsoleteAttribute). Nepoužívejte podtržítko (_).
4.4 Výčtové typy Použijte Pascal case. Zkratky používejte s rozvahou. Za názvem nepoužívejte příponu Enum. Použijte jednotné číslo pro název běžných výčtových typů, množné číslo pro název výčtového typu který je tvořený bitovými hodnotami. Vždy použijte FlagsAttribute u výčtového typu tvořeného bitovými hodnotami.
4.5 Statické položky (Static Fields) Použijte Pascal case. K pojmenování použijte podstatné jméno. Snažte se používat statické vlastnosti místo statických položek.
4.6 Parametry Použijte Camel case. Snažte se aby název parametru odpovídal významu.
4.7 Metody Použijte Pascal case. Použijte slovesa pro název metody (např. Compute, Start, atd.)
4.8 Vlastnosti K pojmenování použijte podstatné jméno. Použijte Pascal case. Zvažte použití stejného názvu jako je datový typ (např. BackgroundColor typu Color, VIPCustomer typu Customer, atd.)
4.9 Události Použijte Pascal case. U delegátů obslužné metody použijte příponu EventHandler nebo Callback podle použití. Vždy použijte parametry sender (zdroj události) a e (parametry události), u třídy představující parametry události použijte příponu EventArgs. K pojmenování použijte sloveso (např. Clicked, Painting).
4.10 Jmenné prostory Použijte Pascal case. U krátkých zkratek (System.IO) lze používat velká písmena, u delších zkratek (HTML) se doporučuje Pascal case (Html). Ideální název jmenného prostoru je Firma.Produkt.Oblast, např. Microsoft.VisualBasic.Compatibility.
příklady
privatní proměnná na urovni třídy m_setting Lokalní proměnná na órvni void nebo prop localVar nebo _localVar