Code Codex

A standardized guideline for names in Manufacture

• Variables
  • Input
  • Output
  • Inside function
  • Important variables
  • Temporary values
  • Common names
• Functions
  • Public
  • Private
  • Groups
• Structs
  • Naming
  • Fields
  • Functions
• Enums
• Debug strings
• Misc

Variables

Input Variables

Naming for any data you want the function to have

Syntax: IN_[naMe]

e.g.

  fn render_util_world(&mut self, IN_gameData: &mut SYS_DATA)  

  pub fn DATA_cacheData_ADD(&mut self, IN_dataIndex: &str, IN_data: CACHE_TYPE)

Output Variables

Naming for any data that will be returned but requires intialization first, such as Lists or Vectors

Syntax: OUT_[naMe]

e.g.

  let mut OUT_genTiles: Vec<(usize, usize)> = Vec::new();  
  ...  
  return OUT_genTiles;

Variables inside function

Naming for variables inside the function to not confuse them with global variables

Syntax: w_[naMe]

e.g.

  let mut w_iterCoords: system::coords = IN_pos;

  let w_cellCoords = IN_pos[0] + IN_pos[1] * system::SYS_REND_BUFFER_X;

Constant variables

Naming for system constants or other important variables

System Variables

Syntax: [CATE_GORY]_[SUB_CATEGORY]_[NA_ME]

e.g.

pub const SYS_TICKRATE_BASE: u8 = 8;

Important variables

Syntax: [CATEGORY]_[naMe]

e.g.

  let TIMER_renderTime = Instant::now()

Temporary values

Primarily to stop compiler from whining

Syntax: idkfa_[naMe]

  let mut idkfa_playerPos = DATA_LOCK.DATA_player.p_pos

Common variable names

Common names for reocurring variables
Following this is advised

Position: IN_pos | w_[...]Pos | OUT_pos
System data: &mut IN_sysData
Indexing for Hashmaps: IN_dataIndex
Timers for speed check: TIMER_[...]Time | loopStart

Functions

Public Functions

Naming for functions that will be used outside the struct/module

Syntax: [CATEGORY]_[naMe]

e.g.

  pub fn MAIN_renderGame(&mut self)

Private Functions

Naming for functions that will be used internally by struct/module only

Syntax: [cateGory]_[subCategory]_[naMe]

e.g.

  fn render_util_text(&mut self)

Function Groups

Naming for groups of functions that do similar operations

Syntax: [CATEgoRy]_[groUp]_[TYPE]

e.g.

  pub fn DATA_cacheData_GET(&self, IN_dataIndex: &str)

Structs

Struct Naming

Naming for structs

Syntax: [TYPE]_[naMe]

e.g.

  pub struct Data_dataMaster

Struct Fields

Naming for struct fields

Syntax: [CATEGORY]_[naMe]

e.g.

  pub DATA_debug: HashMap<String, DATA_debugItem>,

Struct Functions

Naming for struct functions

Same rules as those in Functions section

Additionally, if the struct is specialized in one thing only (i.e. Renderer, Logic), it must have a MAIN_ function to start their process

Enums

Naming for enums

Syntax: [TYPE]_[naMe]

e.g.

  pub enum DATA_cacheType

Debug Strings

Naming for strings that will be used for debug

Syntax: .DEBUG_[cateGory]/#[CATEGORY]_[naMe]

e.g.

  ".DEBUG_sys":{
    "#SYS_dataContainerInit": "Data Container initialized",

Misc

Naming for miscellaneous things

Global values lock

Syntax: [NAME]_LOCK

  let mut DATA_LOCK = data.lock().unwrap()

Uncategorized stuff

Syntax: IDDQD_[naMe]

  pub struct IDDQD_textItem