Style Guide

[dejai]

Do you have a standard set for how you indent your code to make it more manageable and readable? I am specifically asking this question to the elysian shadows development team as I don't want to be flooded with every ones personal indentation. Nor do I want this to turn into an Emacs vs Vi war because we all know that Emacs is much better. Anyway thanks.

[eatcomics]

I think it's more of a personal thing, I bet they all do it the way their used to. Once you get one you like you stick with it...

[dejai]

Not if your working for someone.

OSI examples:
Linux (1TB)
BSD (Allman)

[eatcomics]

ahh, I stand corrected, but I bet the team does it the way I said... but I guess we'll find out

[MarauderIIC]

Do you have a standard set for how you indent your code to make it more manageable and readable? I am specifically asking this question to the elysian shadows development team as I don't want to be flooded with every ones personal indentation.

Yes. And naming conventions, too.

[eatcomics]

Darn, I'm just being wrong all over the place!!!

[Falco Girgis]

Of course we god. You can't work in a team without that stuff.

[Innerscope]

Nor do I want this to turn into an Emacs vs Vi war because we all know that Emacs is much better.

...But Vim rules!!! , jk
You're writing C++ programs in emacs? What are you, a masochist?

I am specifically asking this question to the elysian shadows development team as I don't want to be flooded with every ones personal indentation.

That's too bad, because I'm going to tell you my style and indentation anyway

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) {
          do code;
     }
}

/*
Naming conventions:
Class: Sprite -> Extended Class: GameSprite
Members: mImage, mPosition, mAnimIndex    
Functions: Move, SetSpriteSheet, StartAnimation 
*/

Definitely not all there is to show, but you get the basic idea...
If I were to work for someone else, it wouldn't be difficult for me to conform to their naming conventions/style though. I notice a lot of trained programmers are very similar (in indentation style) anyway.

[thejahooli]

100th post for me

My naming convention is the same as most people from what I have seen.

Code: Select all

// Variables start with lowercase and each new word is captial
int playerPosition;
// Functions start with Capital and each new word is capital
void FunctionOne() { }
// Class name is same as a function name
class PlayerClass
{
};
// constants and enums values in all caps, enum name same as class
const int ACONST;
enum Animal { DOG, CAT, BIRD };

As for indentation I use the default that visual studio does.
Also curly brackets have nothing on their line and if, for, etc. statements allways have curly brackets even with a single line within them.

[ismetteren]

100th post for me

My naming convention is the same as most people from what I have seen.

I see you use capital letters for functions, how manydoes that? (i dosent, unless i use C#, since visual studio is forcing it on me... or maybe im just too lazy to change it. But i does not use C# much anyway... :P)

[thejahooli]

100th post for me

My naming convention is the same as most people from what I have seen.

I see you use capital letters for functions, how manydoes that? (i dosent, unless i use C#, since visual studio is forcing it on me... or maybe im just too lazy to change it. But i does not use C# much anyway... :P)

I can never remember seeing anyone who doesn't do this.

EDIT: Actually I have seen some people who switch what I do between variables and functions, but only a very small amount.

[dandymcgee]

Of course we god. You can't work in a team without that stuff.

What?

[eatcomics]

I was wondering that myself... I think he just really sucks at spelling do

[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:

That's too bad, because I'm going to tell you my style and indentation anyway

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) {
          do code;
     }
}

/*
Naming conventions:
Class: Sprite -> Extended Class: GameSprite
Members: mImage, mPosition, mAnimIndex    
Functions: Move, SetSpriteSheet, StartAnimation 
*/

Definitely not all there is to show, but you get the basic idea...
If I were to work for someone else, it wouldn't be difficult for me to conform to their naming conventions/style though. I notice a lot of trained programmers are very similar (in indentation style) anyway.

[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;
     }
}