// Formatting your code makes it easier to read and understand.
// There are many opinions about what exactly constitutes
// clean code, but everyone can agree that consistency is important.
// Here are a few simple rules that can help you format your code:
public class TestClass
{
// Place private fields at the top of the class, followed by public fields.
private int m_privateField;
public int m_publicField;
// Enter an empty line between each field and property/function.
public int M_PublicProperty { get; set; }
// Use const or readonly for immutable fields.
private const string m_immutable = “Immutable”;
// Prefix public fields, properties, methods and events with a capital letter.
public void DoSomething() { }
// Prefix private fields and methods with an underscore.
private void DoSomethingElse() { }
// Use camelCase for local variables and method parameters.
private void DoSomethingWith(int i) { }
// For readability, use explicit access modifiers (private, protected, etc.).
protected void DoSomethingProtected() {
If you are writing C
// Code goes here
/*
these bracket should be on a new line not at the end of the preceding line of code:
if (i == 0)
{
// Do Stuff
}
while (true)
{
// Do Stuff
}
do
{
// Do Stuff, then goto previous line and remove the semicolon. (dont use do loops)
} while (true);
for (int i = 0; i < 10; i++) // For loops are fine on one line, but you shouldnt use them in C
First of all, I'm going to assume that you know how to create a class that looks like this:
public class MyClass
{
public string Name { get; set; }
public int Age { get; set; }
public void MyMethod(MyClass myClass)
{
var x = 3;
var y = "Hello World";
if (x == 3 && y == "Hello World")
{
}
if (myClass != null)
{
}
}
private void Method()
{
var a = new ClassA();
var b = new ClassB();
a.Method1();
if (a.Property) b.Method2();
a.Method3(b);
b.Method4(a); // Right aligned.
if (!a.Property) b.Method5(); // Right aligned with indentation for readability of the contents of the if statement. (Do not use tabs.)
switch (a.Property) // Right aligned and indented for readability of the case blocks within the switch statement. (Do not use tabs.)
{
case A: // Do