master
Colin McMillen 4 years ago
parent
commit
586eb334d7
  1. 8
      Style-Guide.md

8
Style-Guide.md

@ -1,6 +1,6 @@
## Languages Used
All game code is written to target C# 8.0. Auxiliary tools are written to target Python 3 or unix shell.
All game code is written to target C# 8.0. Auxiliary tools are written to target Python 3 or Unix shell.
## C# Style Guide
@ -54,6 +54,12 @@ if (LongMethodName() && reasonablyLengthyLocalVariable &&
}
```
If a URL is too long to fit on a single line, make sure it's on a line by itself after a //-style comment, like:
```csharp
// Good background reading, eventually:
// https://gamasutra.com/blogs/ItayKeren/20150511/243083/Scroll_Back_The_Theory_and_Practice_of_Cameras_in_SideScrollers.php
```
### Names
Methods & functions are named with an initial capital letter, as is common in other C# code (`DoSomething()`, not `doSomething()`). So are public fields of classes and structs (including properties).

Loading…
Cancel
Save