The battleofmages from renokun

battleofmages's Introduction

#Battle of Mages

##General info

An open source MOBA, see https://battleofmages.com for more info.

##Code Style Guide

###TL;DR

using System;
using System.Collections.Generic;

namespace Example {
	// Test
	public class Test {
		public string firstField;
		public string secondField;
		
		private string privateField;
		
		// Start
		void Start() {
			var x = 42;
			var y = 1337;
			
			// This is an awesome if statement
			if(false) {
				//DisabledCode();
			} else {
				//DisabledCode();
			}
		}
		
		// Update
		public void Update(string[] args) {
			for(int i = 0; i < 10; i++) {
				Console.WriteLine("{0}: Test", i);
			}
		}
	}
}

Rules

Indenting via tabs, aligning via spaces
Namespace, class and function names are written in PascalCase
Variables are written in camelCase
Always use var unless you can't or unless you really want to emphasize the data type
Empty line separating the using block and the rest of code
Empty line between 2 functions
No empty lines at the start or end of the file
Comments start with // followed by a space
Disabled code starts with // not followed by a space
Always add a comment directly above the function definition containing the function name or an explanation
One using declaration per line, no empty lines between them
No spaces before the bracket of a function call or array index access
One space before the opening bracket { of a block
One space after the ending bracket } of a block if it is followed by a second block (e.g. else, catch, ...)
Follow-up blocks like else and catch are written on the same line as the ending bracket } of the preceding block
A comment // that is not at the first line of a block needs to be preceded by a new line
Private class fields need to explicitly state that they are private
The very first block in a source file is not preceded by a comment
A block requires a new empty line before and after it if there is more code in the same block

Recommend Projects