Monday, August 28, 2023

Project naming convention

 Asset

_ProjectName(Contain all assets were created by Team members)

Animation

Characters

….

Audio/Sound

VFX

MusicBackground

Editors

Resources

Data

Popups

Prefabs

Characters

Effects

Weapons

Scenes

SceneName

Scripts

Controllers

Managers

UI

Common

Background

External Sdk/Plugins

External Sdk/Plugins

….


Scene Structure

SceneName

Main Camera

Dynamic Objects

Canvas

HUD

PauseMenu

….

Management


Naming Convention

public class NameOfClass

{

public string NameOfVariable (for all kind of public variables)

private string _nameOfVariable (for all kind of private variables)

protected void FunctionName(string nameOfVariable){}

private void FunctionName(string nameOfVariable){}

public void FunctionName(string nameOfVariable){}

}


Name of Assets

Avoid: Scene Name, Prefab Name…

Button: btn_ButtonName_OtherAspect.

Background: bg_BackgroundName_OtherAspect.

Prefab: PrefabName.

Scene: SceneName.

Temporary Assets/Folder: __FolderName, __AssetName…(double underscore → this mean for testing and delete later).