1
edit
Changes
Created page with '{{OOP344 Index | 20113}} =Code Standards= Fardad suggested in class today that we make a document that defines the format that our code is presented in so I've made this page to…'
{{OOP344 Index | 20113}}
=Code Standards=
Fardad suggested in class today that we make a document that defines the format that our code is presented in so I've made this page to outline them.
==If Statement==
<syntaxhighlight lang="cpp">
if (condition){
stuff;
}
else if (condition){
stuff;
}
else {
stuff;
}
</syntaxhighlight>
Notice the space between the 'if' and '(' and the lack of a space between the ')' and '{'. Also the 'else' starts a line under the '}'.
If the "stuff" is only one line the curly braces can be omitted.
==For Loop==
<syntaxhighlight lang="cpp">
for (i=0; condition; i++){
stuff;
}
</syntaxhighlight>
Notice the space after the 'for' and the lack of space between the ')' and '{'
Similar deal as with the if statement if "stuff" is only one like the curly braces can be omitted.
==While Loop==
<syntaxhighlight lang="cpp">
while (true){
stuff;
}
</syntaxhighlight>
Notice the space after the 'while' and the lack of space after the ')' and '{'.
Also the curly braces can be omitted if "stuff" is only one line.
==Function Declarations==
<syntaxhighlight lang="cpp">
void foo(int a){
stuff;
}
</syntaxhighlight>
The function header isn't indented at all and the first line follows immediately after with one indent.
Also there's no space between the ')' and '{'.
==Indents==
I think each indent should be the equivalent of two spaces. You can change the settings of Visual Studio to put in 2 spaces whenever you press tab. This will keep the code properly aligned and if someone isn't used to using tab for indent they can easily just use two spaces.
==Class Member Variables==
I think we should follow Fardad's lead and start all of our class' member variable names with an underscore '_' to differentiate them from other variables.
=Code Standards=
Fardad suggested in class today that we make a document that defines the format that our code is presented in so I've made this page to outline them.
==If Statement==
<syntaxhighlight lang="cpp">
if (condition){
stuff;
}
else if (condition){
stuff;
}
else {
stuff;
}
</syntaxhighlight>
Notice the space between the 'if' and '(' and the lack of a space between the ')' and '{'. Also the 'else' starts a line under the '}'.
If the "stuff" is only one line the curly braces can be omitted.
==For Loop==
<syntaxhighlight lang="cpp">
for (i=0; condition; i++){
stuff;
}
</syntaxhighlight>
Notice the space after the 'for' and the lack of space between the ')' and '{'
Similar deal as with the if statement if "stuff" is only one like the curly braces can be omitted.
==While Loop==
<syntaxhighlight lang="cpp">
while (true){
stuff;
}
</syntaxhighlight>
Notice the space after the 'while' and the lack of space after the ')' and '{'.
Also the curly braces can be omitted if "stuff" is only one line.
==Function Declarations==
<syntaxhighlight lang="cpp">
void foo(int a){
stuff;
}
</syntaxhighlight>
The function header isn't indented at all and the first line follows immediately after with one indent.
Also there's no space between the ')' and '{'.
==Indents==
I think each indent should be the equivalent of two spaces. You can change the settings of Visual Studio to put in 2 spaces whenever you press tab. This will keep the code properly aligned and if someone isn't used to using tab for indent they can easily just use two spaces.
==Class Member Variables==
I think we should follow Fardad's lead and start all of our class' member variable names with an underscore '_' to differentiate them from other variables.
