Engine Naming Convention
by Edward F. Maurina III · in Torque Game Engine · 06/24/2003 (9:07 pm) · 11 replies
This is both a suggestion and a request.
1. I suggest that any official docs that are being worked on include at least a short section (say a table) on the naming convention used in the Torque Engine. i.e. mVar, sgVar2, etc.
2. If someone could post that kind of data to this thread I'd be much obliged.
I am trying to get a better handle on this as part of my Torque learning.
From what I can see, the naming convention used looks like a custom convention and I'm not able to find anything in the forums or resources. I can see it is not followed religiously, regardless I would like to understand it better.
NOTE: Please do not post opinions on naming conventions here unless of course you think this should not be documented. I value people's opinions, but I am looking for information. Discussions about whether hungarian notation is a good or a bad thing, and whether heck will freeze over if you don't use it are interesting, but tend to derail threads rapidly.
Thanks in advance!
-Ed
1. I suggest that any official docs that are being worked on include at least a short section (say a table) on the naming convention used in the Torque Engine. i.e. mVar, sgVar2, etc.
2. If someone could post that kind of data to this thread I'd be much obliged.
I am trying to get a better handle on this as part of my Torque learning.
From what I can see, the naming convention used looks like a custom convention and I'm not able to find anything in the forums or resources. I can see it is not followed religiously, regardless I would like to understand it better.
NOTE: Please do not post opinions on naming conventions here unless of course you think this should not be documented. I value people's opinions, but I am looking for information. Discussions about whether hungarian notation is a good or a bad thing, and whether heck will freeze over if you don't use it are interesting, but tend to derail threads rapidly.
Thanks in advance!
-Ed
About the author
Recent Threads
#2
2. I was asking if we have any documentation on the current convention. I'm not asking people to follow it.
Thanks again.
06/24/2003 (9:27 pm)
1. Thanks for making my point: "Please do not post opinions on naming conventions here..."2. I was asking if we have any documentation on the current convention. I'm not asking people to follow it.
Thanks again.
#3
06/24/2003 (10:14 pm)
Ed - no, we don't have any documentation on this, nor is there likely to be (perhaps a short section in an introduction). Torque's variables are named fairly arbitrarily; in general an m prefixes member variables, and an s prefixes static variables. g's prefix global variables. I think that's it.
#5
My team is going through the spaces versus tabs debate right now, so some guidance that will ensure consistency would be nice.
04/19/2005 (9:27 pm)
Anything changed here? I wanted to ask about GG coding standards in general. Is there a standards document?My team is going through the spaces versus tabs debate right now, so some guidance that will ensure consistency would be nice.
#6
Coding Style
edit: not to say that i follow this or anything ;P
04/19/2005 (9:48 pm)
Hey.. my boss hipped to this a while ago...Its C# but it has some great stuff and is pretty up to date...Things in there like wrapping lines, never space to indent.. camel casing..Coding Style
edit: not to say that i follow this or anything ;P
#7
04/20/2005 (12:53 am)
There was a standards document for Tribes2, and I think one will rise from the ashes not too long from now...
#8
04/21/2005 (4:48 am)
Unfortunately not a lot of editors support tabs for indenting and spaces for alignment (ie. mixed) and choice of editor is a matter of religion. So until my editor gains the mixed-character indent/align capability, I'm going with all spaces. It's perhaps not the best technical solution but it's the most portable to the most projects and tools. Everything *displays* spaces the same, so everyone sees the same thing. (In particular, consider what happens when you view code with a web browser, such as when using ViewCVS.) 
#9
It's been a year so is there a defined: Torque Coding standard, nameing convention, or documentation standard?
Which reminds me - is TGE sticking with 'doxygen' or are we supposed to be using somthing else now?
It seems that even though having a standard doesn't guarantee people will use it, not having one guarantees they won't! Oops - just broke the opinion rule, sorry.. :)
02/21/2006 (5:12 pm)
*bump* It's been a year so is there a defined: Torque Coding standard, nameing convention, or documentation standard?
Which reminds me - is TGE sticking with 'doxygen' or are we supposed to be using somthing else now?
It seems that even though having a standard doesn't guarantee people will use it, not having one guarantees they won't! Oops - just broke the opinion rule, sorry.. :)
Torque Owner Nathan Martin
TRON 2001 Network
So trying to recommend a variable nameing scheme is just as useless as trying to recommend a coding style. Developers simply don't give a fuck. Sorry to be so crude about it, but that's how most developers feel about those kinds of topics. Most will tell you to either "shutup and get back to things that really matter or simply shutup."
Especially open source/free code developers are the crudest of them all ;)