Style Guide

[Falco Girgis]

^

GAYGAYGAYGAYGAYG

[dandymcgee]

I generally only leave the curly brace on the same line when I'm defining a single class in a header file. Anywhere else I move it to the next line just because it makes it much easier to find them. Every now and then I switch between habits for curly braces, but my naming conventions have stayed pretty firm.

[eatcomics]

I recently started keeping my curly things on the same line... IDK why though... oh well... I like it better

[MarauderIIC]

:shock: I have no idea how that happened...

Anyway, I will say that the style that Kendall and I have adopted 100% matches Innerscope:

Member functions StartWithCapitalLetter in the engine now, and members start with m? Aw, I dislike both of those. Guess it's a good thing I'm not programming the engine :P
Although I do occasionally see where it would be beneficial to name members with an m.

[Falco Girgis]

I have no idea how that happened...

Anyway, I will say that the style that Kendall and I have adopted 100% matches Innerscope:

Member functions StartWithCapitalLetter in the engine now, and members start with m? Aw, I dislike both of those. Guess it's a good thing I'm not programming the engine :P
Although I do occasionally see where it would be beneficial to name members with an m.

Oh, actually. I didn't notice that. Maybe not 100%. We don't do mData for members. That does annoy me too.

We did start capitalizing non accessor member functions now like:
object.getMember();
object.setMember();
object.Load();
object.Save();

[Innerscope]

I have no idea how that happened...

Anyway, I will say that the style that Kendall and I have adopted 100% matches Innerscope:

Member functions StartWithCapitalLetter in the engine now, and members start with m? Aw, I dislike both of those. Guess it's a good thing I'm not programming the engine :P
Although I do occasionally see where it would be beneficial to name members with an m.

Oh, actually. I didn't notice that. Maybe not 100%. We don't do mData for members. That does annoy me too.

I tend to do this for organization sake. I will occasionally use a data type identifier for local variables (i.e. Vector vPosition) if the function is complicated. I hear that's looked down upon here as well.

[Bludklok]

Ill show you my style in a simple DoS calculator program...

Code: Select all

#include <iostream>
#include <windows.h>
using namespace std;
int main(){int a,b;a=b=0;cout<<"Input first var: ";cin>>a;cout<<endl;cout<<"Input second var:  ";cin>>b;cout<<endl;cout<<a<<" + "<<b<<" = "<<a+b;cout<<endl;system("pause");return 0;}

For the record, a total of 7 brain tumors, a broken leg, a fractured spine, and an I.Q. reduction of about 95% was suffered in the making of this program. I can feel my brain bleeding. (One of my top priorities in a program is neatness and readability)

On a side note... Imagine debugging a program where the entire source code is on 1 line... "Error on line 3".

[MadPumpkin]

Do you have a standard set for how you indent your code to make it more manageable and readable?

what is... readable? and.... manageable?
readable code? what is that?

[MadPumpkin]

My indentation matches in Innerscope's. But my curly brace placement is different.

Code: Select all

class Sprite : public Object
{
protected:
     type     protectedMember1;
     type     protectedMember2;

     type     protectedMember3; // no relation to 1 or 2

public:
     Sprite();
     ~Sprite();

     virtual void Render();

     void     SetMemberData(type nData) {protectedMember = nData;}
     void     SetMemberData(type nData);
     return type     GetMemberData() {return mData;}

};

//blocks of code
void Sprite::Render()
{
     local variable declarations;
     render code;

     if(variable1 == variable2)//usually if it's only one call don't even bother with braces
     {
          do code;
     }
}

like wise, mine to

[Falco Girgis]

My indentation matches in Innerscope's. But my curly brace placement is different.

Code: Select all

class Sprite : public Object
{
protected:
     type     protectedMember1;
     type     protectedMember2;

     type     protectedMember3; // no relation to 1 or 2

public:
     Sprite();
     ~Sprite();

     virtual void Render();

     void     SetMemberData(type nData) {protectedMember = nData;}
     void     SetMemberData(type nData);
     return type     GetMemberData() {return mData;}

};

//blocks of code
void Sprite::Render()
{
     local variable declarations;
     render code;

     if(variable1 == variable2)//usually if it's only one call don't even bother with braces
     {
          do code;
     }
}

like wise, mine to

Mar, I think we need a forum-wide ban on everybody who does their braces like:

Code: Select all

if(some bullshit) 
{

}

Because everybody knows that

Code: Select all

if(proper) {

}

is the proper practice!

[eatcomics]

RIGHT ON FALCO!!!!

[dandymcgee]

I'm going to switch just because Falco said that. Falco is my idol. He knows best.

[gordon]

I guess Falco doesn't get on well with the GNU coding guidelines then....

http://www.gnu.org/prep/standards/html_ ... tting.html

To be honest I prefer the following

Code: Select all

if(something){

}

but I can understand the need to put up with both depending on the project.

[M_D_K]

My indentation matches in Innerscope's. But my curly brace placement is different.

Code: Select all

class Sprite : public Object
{
protected:
     type     protectedMember1;
     type     protectedMember2;

     type     protectedMember3; // no relation to 1 or 2

public:
     Sprite();
     ~Sprite();

     virtual void Render();

     void     SetMemberData(type nData) {protectedMember = nData;}
     void     SetMemberData(type nData);
     return type     GetMemberData() {return mData;}

};

//blocks of code
void Sprite::Render()
{
     local variable declarations;
     render code;

     if(variable1 == variable2)//usually if it's only one call don't even bother with braces
     {
          do code;
     }
}

like wise, mine to

Mar, I think we need a forum-wide ban on everybody who does their braces like:

Code: Select all

if(some bullshit) 
{

}

Because everybody knows that

Code: Select all

if(proper) {

}

is the proper practice!

You can try to ban me

[dandymcgee]

You can try to ban me

Speaking from experience: I wouldn't say that if I were you..