Welcome to Cognitive X Solutions Inc C# Style Guide!

Welcome to the Cognitive X Solutions C# Style Guide. The follow guide will outline to you how Cognitive X writes C# code. The guidelines are laid out in a simple format prefixed with the terms DO, CONSIDER, AVOID, DON’T. There are times when these guidelines might need to be violated, but there should be a clear and compelling reason to do so (and should be discussed with team before doing so).

This guide is based on https://msdn.microsoft.com/en-us/library/ms229042.aspx

• Naming Conventions
  • Identifiers
    • Rules for Compound Words
    • Case Sensitivity
  • General Naming Conventions
    • Word choice
    • Abbreviations and Acronyms
    • Avoid Language Specific Names
  • Naming New Versions of an Existing API
  • Names of Assemblies and DLLs
  • Names of Namespaces
  • Names of Classes, Structs, and Interfaces
    • Names of Generic Type Parameters
    • Names of Common Types
    • Naming Enumerations
  • Names of Type Members
    • Names of Methods
    • Names of Properties
    • Names of Events
    • Names of Fields
  • Naming Parameters
    • Naming Operator Overload Parameters
  • Naming Resources
• Type Design Guidelines
  • Choosing Between Class and Struct
  • Abstract Class Design
  • Static Class Design
  • Interface Design
  • Struct Design
  • Enum Design
    • Designing Flag Enums
    • Adding Value to Enums
  • Nested Types
• Member Design Guidelines
  • Member Overloading
  • Property Design
    • Indexed Property Design
    • Property Change Notification Events
  • Constructor Design
    • Type Constructor Guidelines
  • Event Design
    • Custom Event Handler Design
  • Field Design
  • Extension Methods
  • Operator overloads
    • Overloading Operator ==
    • Conversion Operators
  • Parameter Design
    • Choosing Between Enum and Boolean Parameters
    • Validating Arguments
    • Parameter Passing
    • Members with Variable Number of Parameters
    • Pointer Parameters