Thread: Clean Code...

Hi,
I totally agree with nvoigt.. Thats its more a sort of personal about the styling of the code..

What you need to do is have a standard notation as to how you would identify a variable it a const. or not how would you declear a gobal variable. eg. #defined variables are usally in Caps.

One more thing is that you need to give in more comments. Some times (personals experiance) when you right a piece of code you might think that its very trival but when you look at it after couple of times you really find it difficiult to understand.

check out the book.. " The Practice of Programming " by, Brian W Kernighan and Rob Pike. it might help.. :-)

happy coding..

A few things that might help you that took me 3 or 4 years to pick up:
- verbose variable names (cryptic names such as f and dii are bad)
- document your code (with comments) as you write it, assuming anyone else could be reading it at some point
- use more spaces, (hat<4)&&(bat>'j') is less readable than (hat < 4) && (bat > 'j')
- This was extremely painful for me, but try to use industry standards where appropriate, if your programming for windows you should probably use hungarian notation and microsofts standards, for unix and linux you will probably have underscores in your function names and less camel caps

I haven't actually come across any consolidated source, I have found scattered sources, but I use the conventions found in device driver and header code.
It's apparent that FunctionWithCamelCaps are preferred over unix_style, hungarian notation is used, TRUE and FALSE are used over true and false. Most mfc classes have C prepended to the name (eg CObject).
If you search google you should find some sources that have bits and chunks of information, msdn has some articles too.