zann1x/jarp

Change naming convention / check correctness

Closed this issue · 0 comments

With the current coding standard in this project, some problems appeared like

  • being unsure if the variable is a member of the class
  • same names for member and parameter
  • same names for classes/structs and variables
  • Intellisense and code highlighting thinking that a variable actually is a class

To fix this, a new standard needs to be chosen and applied to the whole project, so we need to switch from basically everything starting with an uppercase letter besides pointers ans having no prefixes at all to the prefixes

  • m_ for member attributes
  • s_ for static member variables
  • b for boolean
  • out for parameters passed by ref
  • T for templates
  • S for structs

as well as camelCase for variables and methods and CamelCase for classes and structs.

The coding standard I prefer then, should be documented so possible contributors can reference that when writing code.