Proposal : Coding style

Everything related to the code /
Tout ce qui touche au code
Post Reply
milipili
Posts: 545
Joined: Thu Nov 02, 2006 8:52 am
Location: Paris (France)
Contact:

Proposal : Coding style

Post by milipili » Sun Jun 08, 2008 3:20 pm

Here is a common used coding style we use at work :
http://ftn.shikami.org/misc/codingstyle.txt
(based on `if not forbidden it's allowed`)

Personally, I like it, so I propose it to you.
Damien Gerard
Ta3d & Yuni Developer

User avatar
zuzuf
Administrateur - Site Admin
Posts: 3281
Joined: Mon Oct 30, 2006 8:49 pm
Location: Toulouse, France
Contact:

Post by zuzuf » Sun Jun 08, 2008 3:43 pm

I suggest we use capital letters with '_' for class names since it's what is most used through the project and will required few changes.
=>;-D Penguin Powered

milipili
Posts: 545
Joined: Thu Nov 02, 2006 8:52 am
Location: Paris (France)
Contact:

Post by milipili » Sun Jun 08, 2008 5:37 pm

Like this ?

Code: Select all

class Here_Is_My_Class {};
Damien Gerard
Ta3d & Yuni Developer

User avatar
zuzuf
Administrateur - Site Admin
Posts: 3281
Joined: Mon Oct 30, 2006 8:49 pm
Location: Toulouse, France
Contact:

Post by zuzuf » Sun Jun 08, 2008 8:17 pm

like this:

Code: Select all

class INGAME_UNITS {};
=>;-D Penguin Powered

User avatar
AF
Administrateur - Site Admin
Posts: 139
Joined: Thu Dec 28, 2006 8:19 pm
Location: NW UK
Contact:

Post by AF » Sun Jun 08, 2008 8:40 pm

Wouldn't that confuse with Macros?

I always found capitalizing the first letter of every word in a class and prefixing with C or I depending on the class type was best for me, and then capitalizing the first letter of every word except the first in variable names.

milipili
Posts: 545
Joined: Thu Nov 02, 2006 8:52 am
Location: Paris (France)
Contact:

Post by milipili » Mon Jun 09, 2008 6:32 am

Yes it is confusing with Macros for my part too.
Damien Gerard
Ta3d & Yuni Developer

milipili
Posts: 545
Joined: Thu Nov 02, 2006 8:52 am
Location: Paris (France)
Contact:

Post by milipili » Mon Jun 09, 2008 6:35 am

However a prefix with a `C`/`I` is quite useless actually.
Damien Gerard
Ta3d & Yuni Developer

milipili
Posts: 545
Joined: Thu Nov 02, 2006 8:52 am
Location: Paris (France)
Contact:

Post by milipili » Tue Jun 10, 2008 8:30 am

Honestly, if we could avoid class names like that MA_CLASS, it would be really nice... You never know the expected behavior, if it is a class or a define.
Damien Gerard
Ta3d & Yuni Developer

Post Reply

Who is online

Users browsing this forum: No registered users and 14 guests