Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs] Pedantically create a code style convention? ;) #29

Open
Zandor300 opened this issue Mar 28, 2018 · 1 comment
Open

[Docs] Pedantically create a code style convention? ;) #29

Zandor300 opened this issue Mar 28, 2018 · 1 comment

Comments

@Zandor300
Copy link
Contributor

Create a file outlining exactly how @BertHeesakkers wants his code to be formatted!

@Zandor300 Zandor300 changed the title Pedantically create a code style convention? ;) [Docs] Pedantically create a code style convention? ;) Mar 28, 2018
@simonrenger
Copy link
Contributor

I think the main rules are: (@BertHeesakkers am I right?)
Barces
Use a new line braces for code blocks:
Wrong:

class Name {}

Correct:

class Name
{
[...]
}

Variables naming

  • Member function or function arguments in general are having the prefix: a_
  • Member function or function arguments using Upper Camel Case
  • Member variables use the prefix m_
  • Member variables are following the Upper Camel Case rule
  • Global variables have the prefix g_
  • Global variables are following the Upper Camel Case rule as well
  • Local variables are following the Lower Camel Case rule

Naming in general
We are trying to give everything local and self-explanatory names so we do not need to add comments to understand the flow of the program.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants