SPSUnityUtilities

SuperPupStudio Unity Utilities

naming convention

• class name noun PascalCase
• public class var camelCase
• private class var m_camelCase
• function PascalCase
• method PascalCase
• parameters _camelCase

documenting code

editor

• [Header("")]
• [Tooltip("")]

public functions/methods recommended

/// <summary>
/// Start timer will start the timer with the values passed in or
/// the public class variables are null.
/// </summary>
/// <param name="_countDown">The amount of time in seconds the timer will run.</param>
/// <param name="_autoRestart">If true the timer will restart when finish.</param>
/// <return>message about return</return>

commit guideline

message

[type][ticket][message]

Type

• [DOC] Documentation
• [FIX] Bug Fix
• [FEATURE]
• [BUILD] Build/Dependencies

branch

lower-case with - used instead of space