{"id":3997,"date":"2021-02-15T05:44:19","date_gmt":"2021-02-15T05:44:19","guid":{"rendered":"https:\/\/studysection.com\/blog\/?p=3997"},"modified":"2021-02-15T06:44:12","modified_gmt":"2021-02-15T06:44:12","slug":"c-coding-standards-and-best-practices","status":"publish","type":"post","link":"https:\/\/studysection.com\/blog\/c-coding-standards-and-best-practices\/","title":{"rendered":"C# Coding Standards and Best Practices"},"content":{"rendered":"

I am going to describe here several rules and conventions which are useful for developing applications and class libraries in C#. Here, the main goal is to define guidelines to enforce the consistent style and formatting to help developers avoid common mistakes <\/a>while coding in C#.<\/p>\n

Naming Conventions<\/h2>\n

General Guidelines<\/strong><\/p>\n

    \n
  1. Always use Camel Case or Pascal Case names for naming conventions.<\/li>\n
  2. Avoid ALL CAPS and all lowercase names. Although single lowercase words or letters are acceptable.<\/li>\n
  3. Do not use names that begin with a numeric character.<\/li>\n
  4. Always choose meaningful and specific names.<\/li>\n
  5. Do not use abbreviations unless the full name is enormous.<\/li>\n
  6. Avoid including the parent class name within a property name.
    \nExample:
    \nCustomer.Name <\/em>\t\/\/Good
    \nCustomer.CustomerName<\/em>\t\t\/\/Bad<\/code><\/li>\n
  7. It is better to prefix Boolean variables and properties with \u201cCan<\/strong>\u201d, \u201cIs<\/strong>\u201d or \u201cHas<\/strong>\u201d like \u201cCanPopulate<\/strong>\u201d, \u201cIsValid<\/strong>\u201d or \u201cHasContent<\/strong>\u201d, etc.<\/li>\n
  8. Do not use Hungarian Notation!
    \nExample: strName or iCount<\/em><\/li>\n
  9. Any Abbreviations must be widely known and accepted and avoid abbreviations longer than 5 characters.<\/li>\n
  10. For two-letter abbreviations, use uppercase and Pascal Case for longer abbreviations.<\/li>\n
  11. Do not use C# reserved words as names. <\/li>\n
  12. Avoid adding redundant or meaningless prefixes and suffixes to identifiers
    \nExample:
    \n\/\/ Bad!
    \npublic enum ColorsEnum {\u2026}
    \npublic class CVehicle {\u2026}
    \npublic struct RectangleStruct {\u2026}<\/code>\n<\/li>\n<\/ol>\n

    Name Usage & Syntax<\/strong><\/p>\n