Coding Standards - HaydosBruh/Battleships GitHub Wiki

Below are our coding standards and naming conventions for c#

DO use PascalCasing for class names and method names.

DO use camelCasing for method arguments and local variables.

DO use PascalCasing for abbreviations 3 characters or more (2 chars are both uppercase)

DO use predefined type names instead of system type names like Int16, Single, UInt64, etc

DO use implicit type var for local variable declarations. Exception: primitive types (int, string, double, etc) use predefined names.

DO use noun or noun phrases to name a class.

DO prefix interfaces with the letter I. Interface names are noun (phrases) or adjectives.

DO name source files according to their main classes. Exception: file names with partial classes reflect their source or purpose, e.g. designer, generated, etc.

DO organize namespaces with a clearly defined structure.

DO vertically align curly brackets.

DO declare all member variables at the top of a class, with static variables at the very top.

DO use singular names for enums. Exception: bit field enums.