Tento článek pojednává o konvenci pojmenování proměnných, kolekcí, typů a polí v rámci souboru Site.config. Uvedená jména mohou obsahovat pouze písmena anglické abecedy, číslice a znak podtržítka _. Jména musí vždy začínat písmenem a jsou case-sensitive.
V celé dokumentaci striktně dodržujeme níže uvedené konvence pojmenování typů, proměnných a kolekcí. Doporučujeme se jich zpočátku držet i ve vašich projektech – budete se v Site.config a dokumentaci snadněji orientovat.
Proměnné a kolekce
Proměnné a kolekce jsou pojmenovávány s malým počátečním písmenem. Pokud se jméno skládá z více slov, spojují se bez mezer a bez podtržítek a každé další slovo začíná velkým písmenem. Používá se tedy tzv. lowerCamelCase. Jména kolekcí jsou v jednotném čísle a mají příponu Col.
<Var name="homePage" type="HomePage" /> <Collection name="productCol" itemType="ProductItem" />
Typy
Typy jsou pojmenovávány s velkým počátečním písmenem. Pokud se jméno skládá z více slov, spojují se bez mezer a bez podtržítek a každé další slovo začíná velkým písmenem. Používá se tedy tzv. UpperCamelCase. Typy, které představují prvek kolekce, jsou v jednotném čísle a mají příponu Item.
<Type name="HomePage"> ... </Type> <Type name="ProductItem"> ... </Type>
Pro typy kolekcí, které jsou součástí jiného typu, je používána navíc předpona shodná se jménem typu, ve kterém je kolekce umístěna. Předpona už ale není opakována ve jménu kolekce. Např.:
<Type name="ProductItem">
...
<Collection name="categoryCol" itemType="ProductCategoryItem" />
</Type>
<Type name="ProductCategoryItem"> ... </Type>
Jazyk
Všechna jména jsou anglicky – hlavně z důvodu pravidelnosti množného čísla.
Poznámky
Některá jména proměnných, typů, ale zejména polí nejsou povolena, aby nedocházelo ke kolizím např. s vnitřními poli proměnných. Pole proměnné tak nelze pojmenovat např. id, next nebo this. Při použití nepovoleného názvu je vyhozena výjimka config souboru.