README.md

Coding Conventions

Coding conventions for C# in Unity

Downloads

• Jetbrains Rider settings
• Jetbrains Resharper settings
• Visual Studio Settings

IDEs

• Jetbrains Rider
  • Unity Support
  • Heap Allocations Viewer
  • Hunspell
• Visual Studio Community 2017
  • ReSharper
    • Resharper Settings v0.1
    • Heapview
    • Resharper Unity
  • Spell Checker
• Notepad ++
  • Shader highlighting theme

Naming Conventions

Follow these naming conventions: http://www.dofactory.com/reference/csharp-coding-standards

Unity specific

• Use [SerializeField] (with a public property if necessary) instead of public fields.

  [SerializeField]
  private int someInt = 0;
  ...
  public int SomeInt { get {return someInt; } }

• Use [Tooltip("")] for commenting fields

  [Tooltip("Changes the horizontal speed of the player")]
  [SerializeField]
  private float horizontalSpeed = 2f;

• Use [Unit("")] to give extra information about the unit of a field

  [Unit("meters/second")]
  [SerializeField]
  private float startVelocity = 5f;

• Use [HideInNormalInspector] instead of [HideInInspector] in order to still see the values in the debug inspector

  [Tooltip("The precalculated squared maximum speed for faster comparison")]
  [HideInNormalInspector]
  [SerializeField]
  private float squaredMaxSpeed = 5f;

• If not explicitly required to have a component use Reset() instead of [RequireComponent()]
• Use OnValidate() to precalculate properties
• Pack all editor scripts like Reset(), OnValidate() or other methods only used in the editor at the end of the class and encapsulate them with #if UNITY_EDITOR #endif

  #if UNITY_EDITOR
  [Button]
  private void SortArray()
  {
    Array.Sort(sortedArray);
  }
  
  private void Reset()
  {
    if(player == null)
    {
      player = GetComponent<Player>();
    }
  }
  
  // Called whenever the user changes a value in the inspector
  private void OnValidate()
  {
    reciprocalValue = 1f/value;
    squaredMaxSpeed = maxSpeed * maxSpeed;
  }
  #endif