1 /******************************************************************************
2 Style Guidelines:
3 * Readability - code is easy to read and to understand
4 * Standardisation - all team members are aligned with same code style
5 * Self-descriptive code - code is easy to understand without comments
6 * Debuggable - code is easy to debug (IDE friendly)
7 ******************************************************************************/
8
9 // types are defined within the scope of namespace
10 // space name starts with Upper case letter
11 // each following word starts with upper Case letter
12 // sub-spaces are divided by '.' (dot)
13 // here "MyNameSpace" is main space and "Enums" is sub-space
14 namespace MyNameSpace.Enums
15 {
16 /// <summary>
17 /// type name starts with Upper case letter
18 /// each following word starts with Upper Case letter
19 /// <remarks>
20 /// type = class, enum, struct, delegate. interface, etc
21 /// </remarks>
22 /// </summary>
23 public enum MyEnum
24 {
25 /// <summary>
26 /// enum member name starts with Upper case letter
27 /// each following word starts with Upper case letter
28 /// </summary>
29 EnumMember1,
30
31 EnumMember2
32 }
33 }