STYLEGUIDE.md

Coding Guidelines

Definitions

• CamelCase is a casing convention where the first letter is lower-case, words are not separated by any character but have their first letter capitalized. Example: thisIsCamelCased.
• PascalCase is a casing convention where the first letter of each word is capitalized, and no separating character is included between words. Example: ThisIsPascalCased.

C# coding conventions

We should use the Allman bracing style for consistency.

We are using the C# coding conventions described in this document as a guide, not everything in this doc is gospel and is open to debate: C# Coding Guidelines with the following exceptions:

• Each file should not start with a copyright notice. The ones at the root of the source tree will suffice.
• Regions (#region) are not used.
• using statements are on top of a file (outside of namespace {...})
• Use var only if you have an anonymous type or you can clearly tell what the type is from the right hand side of the expression
• Member variables should always be private, public access should be provided by an encapsulated property.
• While each source file should be limited to a single public class, nested classes applicable to only their parent class are permited.
• In the case of defining a kerboscript function class to serve as a constructor for a specific structure, this function class should be nested at the top of the structure it returns. For example:

      public class ExampleStructure : Structure
      {
    	  [Function("example")] // insert the function at the top of the class
    	  public class FunctionExampleStructureConstructor
    	  {
    		  public override void Execute()
    		  {
    			  // insert logic here
    		  }
    	  }
  
    	  // insert member variables/constructors/methods per the style guide
      }
  

Naming

Follow all .NET Framework Design Guidelines for both internal and external members. Highlights of these include:

• Do use camelCasing for member variables, parameters and local variables
• Do use PascalCasing for function, property, event, and class names
• Do prefix interfaces names with “I”
• Do not use Hungarian notation
• Do not use a prefix for member variables (, m, s_, etc.). If you want to distinguish between local and member variables you should use “this.”
• Do not prefix enums, classes, or delegates with any letter

Here is some sample code that follows these conventions.

using System;
namespace NuGet
{
	public class ClassName
	{
		private List<SomeType> privateMember;

		public List<SomeType> SomeProperty
		{
			get
			{
				return privateMember;
			}
		}

		public string SomeAutoProperty { get; set; }

		public string SomeMethod(bool someCondition)
		{
			if (someCondition)
			{
				DoSomething(someArgument);
			}
			else
			{
				return someArray[10];
			}

			switch (status)
			{
				case Status.Foo:
					return "Foo";

				case Status.Bar:
					return "Bar";

				default:
					return "Bar";
			}
			return String.Empty;
		}

		private string AnotherMethod(){
			return privateMember.Count;
		}
	}
}