Teach me how to give a name...

Printable View

07-20-2008
audinue

Teach me how to give a name...

Which do you prefer? TokenA, TokenB, TokenC or TokenD?

Code:

typedef struct { unsigned char *data; unsigned char type; unsigned int line; unsigned int column; } TokenA; typedef struct { unsigned char *data; unsigned char type; unsigned int line; unsigned int column; } TokenB; typedef struct { unsigned char *data; unsigned char type; unsigned int line; unsigned int column; } TokenC; typedef struct { unsigned char *data; unsigned char type; unsigned int line; unsigned int column; } TokenD;

I don't know... Maybe there is something wrong with my brain.

When writing variables, defines, functions or typedefs I'm stuck with their name, spaces and indentation!

...TokenA or Token_A or tokenA or token_a or TOKEN_A... :S

...char *token or char *sToken or char *strToken or char *lpcstrToken...

Could you imagine? Whenever my mood is using MyFunction style...
I will rewrite--yeah! rewrite! the whole function named my_function, then rename it to MyFunction either in the same algorithm or a new one.

Am I crazy? Yes I am.

Somebody help me!! (-*_*-)"
07-20-2008
Adak

I prefer the TokenA style - it's natural looking and avoids obsessing over how the words of differing lengths, all line up in an affected looking manner.
07-20-2008
Prelude

>Which do you prefer?
No, the question really is which do you prefer?

>Am I crazy?
As long as you're consistent within the project, all is well.
07-20-2008
anon

Quote:

Could you imagine? Whenever my mood is using MyFunction style...
I will rewrite--yeah! rewrite! the whole function named my_function, then rename it to MyFunction either in the same algorithm or a new one.

Yes, this sounds sort of crazy.

Imagine working with several 3rd party APIs, each using their own naming conventions...
07-20-2008
C_ntua

TokenA. The rest are too much. Think of it this way. If you try to make the code nice but more impractical, then what's the point? The code isn't nice to win any beauty contest. It is nice to be practical, easy to read and easy to modify. So it should first be practical and then "nice". Though practical codes tend to be nicer anyway.

Now, my_function vs MyFunction vs myFunction. That is a tough call.
First, I would say not MyFunction, but myFunction. One less shift :P
So you have my_function vs myFunction. Now depends on what YOU like.
I would say some advantages (for ME), to give you some ideas:

1) The words are more separate, meaning you can read them more easily. This is useful if you have two long or strange words. Even more useful when you have three words like "my_function_opt" rather than "myFunctionOpt
2) The _ makes the word a little more "ugly". Also it is easier to use the capital letter format, because you just press a shift, not a shift plus -. So if you don't mind, use the myFunction format just because it is easier.
3) It is better to use one format for each program

My advise. Choose one in the beginning and STICK with it!
07-20-2008
anon

Quote:

Also it is easier to use the capital letter format, because you just press a shift, not a shift plus -.

Pressing Shift alone doesn't produce an uppercase character. :)
07-20-2008
audinue

Very reasonable C_ntua... Great!

Speed of typing is one of important things while writing a code.. :)

...Type less get more...
*giggle*

Because of we, the programmers, should be lazy at all XD
07-20-2008
anon

Lazy programmers would use auto-completion by their IDE...
07-20-2008
C_ntua

Quote:

Originally Posted by audinue

Very reasonable C_ntua... Great!

Speed of typing is one of important things while writing a code.. :)

...Type less get more...
*giggle*

Because of we, the programmers, should be lazy at all XD

Personally I HATE symbols like parenthesis, underscore, brackets etc etc (I should be programming in Haskell....) :P
07-20-2008
cpjust

I use TokenB syntax for member variables and something like TokenC syntax for function arguments. I think it's just easier to see the variable types & names when you're looking through the code quickly.
I just wish I could keep my desk as neat & organized as my code. ;)
07-21-2008
matsp

I'm with cpjust on this - but coding style is a personal thing, at least until you start working with other people that have a different idea of what coding style you should use. I don't use the coding style used at work when I write code at home.

--
Mats