This style guide is different from other you may see, because the focus is centered on readability for print and the web. We created this style guide to keep the code in our tutorials consistent.
Our overarching goals are conciseness, readability and simplicity. Also, this guide is written to keep Unity in mind.
This style guide is based on C# and Unity conventions.
- Nomenclature
- Declarations
- Spacing
- Brace Style
- Switch Statements
- Language
- Copyright Statement
- Smiley Face
- Credit
On the whole, naming should follow C# standards.
Namespaces are all PascalCase, multiple words concatenated together, without hypens ( - ) or underscores ( _ ):
BAD:
com.raywenderlich.fpsgame.hud.healthbarGOOD:
RayWenderlich.FPSGame.HUD.HealthbarWritten in PascalCase. For example RadialSlider.
Methods are written in PascalCase. For example DoSomething().
All non-static fields are written camelCase. Per Unity convention, this includes public fields as well.
For example:
public class MyClass
{
public int publicField;
int packagePrivate;
private int myPrivate;
protected int myProtected;
}BAD:
private int _myPrivateVariableGOOD:
private int myPrivateVariableStatic fields are the exception and should be written in PascalCase:
public static int TheAnswer = 42;Parameters are written in camelCase.
BAD:
void DoSomething(Vector3 Location)GOOD:
void DoSomething(Vector3 location)Single character values are to be avoided except for temporary looping variables.
Delegates are written in PascalCase.
When declaring delegates, DO add the suffix EventHandler to names of delegates that are used in events.
BAD:
public delegate void Click()GOOD:
public delegate void ClickEventHandler()DO add the suffix Callback to names of delegates other than those used as event handlers.
BAD:
public delegate void Render()GOOD:
public delegate void RenderCallback()Prefix event methods with the prefix On.
BAD:
public static event CloseCallback Close;GOOD:
public static event CloseCallback OnClose;In code, acronyms should be treated as words. For example:
BAD:
XMLHTTPRequest
String URL
findPostByIDGOOD:
XmlHttpRequest
String url
findPostByIdAccess level modifiers should be explicitly defined for classes, methods and member variables.
Prefer single declaration per line.
BAD:
string username, twitterHandle;GOOD:
string username;
string twitterHandle;Exactly one class per source file, although inner classes are encouraged where scoping appropriate.
All interfaces should be prefaced with the letter I.
BAD:
RadialSliderGOOD:
IRadialSliderSpacing is especially important in raywenderlich.com code, as code needs to be easily readable as part of the tutorial.
Indentation should be done using spaces — never tabs.
Indentation for blocks uses 4 spaces for optimal readability:
BAD:
for (int i = 0; i < 10; i++)
{
Debug.Log("index=" + i);
}GOOD:
for (int i = 0; i < 10; i++)
{
Debug.Log("index=" + i);
}Indentation for line wraps should use 4 spaces (not the default 8):
BAD:
CoolUiWidget widget =
someIncrediblyLongExpression(that, reallyWouldNotFit, on, aSingle, line);GOOD:
CoolUiWidget widget =
someIncrediblyLongExpression(that, reallyWouldNotFit, on, aSingle, line);Lines should be no longer than 100 characters long.
There should be exactly one blank line between methods to aid in visual clarity and organization. Whitespace within methods should separate functionality, but having too many sections in a method often means you should refactor into several methods.
All braces get their own line as it is a C# convention:
BAD:
class MyClass {
void DoSomething() {
if (someTest) {
// ...
} else {
// ...
}
}
}GOOD:
class MyClass
{
void DoSomething()
{
if (someTest)
{
// ...
}
else
{
// ...
}
}
}Conditional statements are always required to be enclosed with braces, irrespective of the number of lines required.
BAD:
if (someTest)
doSomething();
if (someTest) doSomethingElse();GOOD:
if (someTest)
{
DoSomething();
}
if (someTest)
{
DoSomethingElse();
}Switch-statements come with default case by default (heh). When your code is written correctly, it should never reach this part.
Never include the default case.
BAD:
switch (variable)
{
case 1:
break;
case 2:
break;
default:
break;
}GOOD:
switch (variable)
{
case 1:
break;
case 2:
break;
}Use US English spelling.
BAD:
string colour = "red";GOOD:
string color = "red";The exception here is MonoBehaviour as that's what the class is actually called.
The following copyright statement should be included at the top of every source file:
/*
* Copyright (c) 2017 Razeware LLC
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* Notwithstanding the foregoing, you may not use, copy, modify, merge, publish,
* distribute, sublicense, create a derivative work, and/or sell copies of the
* Software in any work that is designed, intended, or marketed for pedagogical or
* instructional purposes related to programming, coding, application development,
* or information technology. Permission for such use, copying, modification,
* merger, publication, distribution, sublicensing, creation of derivative works,
* or sale is expressly withheld.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
Smiley faces are a very prominent style feature of the raywenderlich.com site! It is very important to have the correct smile signifying the immense amount of happiness and excitement for the coding topic. The closing square bracket ] is used because it represents the largest smile able to be captured using ASCII art. A closing parenthesis (":)") creates a half-hearted smile, and thus is not preferred.
BAD:
:)
GOOD:
:]
NOTE: Do not use smileys in your scripts.
This style guide is a collaborative effort from the most stylish raywenderlich.com team members: