C# Naming Standard

In this Article:

🤔 Notice something is missing or not working? → Please contact Zoel (zoelbastianbach@agate.id) on Ms. Teams!

~~https://embed.notionlytics.com/s/VjIxdGJWWmtiRzAzU1c1VVVsbERZMFJ1TURFPQ==~~

Overview

Consistency is the key to maintainable code. This statement is most true for naming your projects, source files, and identifiers including Fields, Variables, Properties, Methods, Parameters, Classes, Interfaces, and Namespaces.

❓ Why should I care about this article?

Naming conventions result in improvements in terms of "four Cs": communication, code integration, consistency and clarity. The idea is that "the code should explain itself". Following a consistent set of naming conventions in the development can be a major contribution to its usability.
🎯 The goal of this article

This article will provide a consistent set of naming conventions utilized in Agate
🤷🏻 If I have further question about this article, who can I reach out to?

Please contact: Fachri Akbar (fachri@agate.id)

The table below is the summary/TL;DR version of the naming conventions in this article:

[Naming Overview](Naming Standard e8d0afdf61254076932a7230c967b92c/Naming Overview 30543ddc7b664078948c460709d767ca.csv)

General Naming Convention

✅ ALWAYS use camelCase or PascalCase names
❌ AVOID the use of ALL CAPS and all lowercase names. Single lowercase words or letters are acceptable.
❌ DO NOT create declarations of the same type (namespace, class, method, property, field, or parameter) and access modifier (protected, public, private, internal) that vary only by capitalization. Assume you will be working with languages that does not support case-sensitivity, even if you know you're not.
```
public int SomeIntVariable;
public int SomeintVariable;
public int SomeIntvariable;
```

❌ DO NOT use names that begin with a numeric character.

// **❌** DO NOT do this:
public class 6AxisControler {}

// **✅** DO this instead:
public class SixAxisControler {}

✅ ALWAYS choose meaningful, self-explanation and specific names

// **❌** DO NOT do this:
public int Asdf;

//a = final position
//b = current position
//c = pivot
a = b – c;

// **✅** DO this instead:
public int BallCount;

finalPos = currentPos – pivot;

Variables and Properties should describe an entity not the type or size. And also do not use Hungarian Notation

// **❌** DO NOT do this:
public int nBall; //number of ball
public bool bBusy; //Boolean variable

// **✅** DO this instead:
public int BallCount;
public bool IsBusy;

❌ AVOID using abbreviations unless the full name is excessive (more than 25 character).

// **❌** DO NOT do this:
public float ExtGlow;
public int GetTheLatestWebSiteAccessTimeInMilliseconds()

// **✅** DO this instead:
public float ExternalGlow;
public int GetLatestWebAccessTimeMillis()

Any Abbreviations must be widely known and accepted.
```
public int Atk;
public int Def;
public float Pow;
```

❌ DO NOT use C# reserved words as names.
❌ AVOID naming conflicts with existing .NET Framework namespaces, or types.

❌ AVOID adding redundant or meaningless prefixes and suffixes to identifiers

// **❌** DO NOT do this:
public enum ColorsEnum
public class CVehicle
public struct RectangleStruct

// **✅** DO this instead:
public enum Colors
public class Vehicle
public struct Rectangle

❌ DO NOT include the parent class name within a property name.

// **❌** DO NOT do this:
public class Customer {
    public int CustomerName;
}

// **✅** DO this instead:
public class Customer {
    public int Name;
}

✅ TRY to prefix boolean variables and properties with “Can”, “Is” or “Has”.
Append computational qualifiers to variable names like Average, Count, Sum, Min, and Max where appropriate.
When defining a root namespace, use a Product, Company, or Developer Name as the root.
```
Agate.ProductName
```

Naming Usage