Topic: Variable Naming Convention

[mmason]

My wandering mind is wondering this evening as I was doing my usual stumbling through some happy vlisp.  It occurred to me that for myself and maybe others a discussion regarding variable names might be a good thing.

I see many different methods people use when naming variables.  Special characters, prefixes and such.  Which begs the question; Is there some sort of semi-standard or (somewhat) universally accepted naming convention for variables in a lisp program?

Some examples might be:
*active-document*, SelectedLayer$, ^IterationList, eb:BlockCollection (where 'eb:' ties the variable to a function such as 'EraseBlock').

Would one format be used for global variables and another for locals?  Another format for collections?

Ideas?  Opinions?

[JohnK]

*big* topic, *many* considerations.

no convention just personal preferences and current uses/structures.

sleep needed.



*lol*

[CAB]

Welcome to The Swamp mlm.

I too am off to bed, see you tomorrow.  ZZzzzz.....

[Chuck Gabriel]

If you see an asterisk at the beginning and end of a variable name, there is a good chance it is a global variable.  I've also seen the prefix (like the eb: you mentioned) used on globals to identify what function they belong to.  I can see how that would ease some maintenance woes.  Other than that, what I've seen seems pretty arbitrary.

Oh yeah, welcome to the swamp.

[Lee Mac]

I normally use the format:

<function_name> : <variable_name>

for my globals, (and sometimes chuck a few special chars in there for good measure), but as for local names...

ent  = ename
ss   = selection set
elst  = entget return
obj  = vla-object
cObj = curve object...

I get lazy though...

[mmason]

*big* topic, *many* considerations.

no convention just personal preferences and current uses/structures.

sleep needed.



*lol*

Welcome to The Swamp mlm.

I too am off to bed, see you tomorrow.  ZZzzzz.....

OK, so we've got 7 seein' stars and at the end of the day, Mr. B likes some Z's 

[Matt__W]

I've always been kinda partial to the VB naming conventions - although, admittedly, I don't always stick to it.   

http://support.microsoft.com/kb/110264

[mmason]

I get lazy though...

I hear that.  In the old days, we did the ol'...
(if (= (+ n1 n2) x) (princ str))

Now I tend to use more like...
(if (= (+ ThisNumberThatIPulledOutOfSomeWhere ThatNumberThatIGotSomeWhereElse) SomeNumberSomeOneToldMeWasWhatIShouldUse) (princ SomeSillyConvolutedMessageToTheUser))

[JohnK]

I have adopted a more descriptive like the later mlm demonstrated.

I tend to shy away from global variables however if needed, i prefix them with a special char.

[mmason]

I've always been kinda partial to the VB naming conventions - although, admittedly, I don't always stick to it.   

http://support.microsoft.com/kb/110264

Now, this makes sense!  Those of us in varying degrees of migrations to and intergrations with .NET along with AutoLISP could employ a somewhat similar methodology to variable naming.  That way the LISP'ers and the .NET'ers could (sort of) understand each other.

Wait!  But then Matt and I would have to start being consistent!?  I'm not sure my wandering mind is up to that task.

[Matt__W]

I've always been kinda partial to the VB naming conventions - although, admittedly, I don't always stick to it.   

http://support.microsoft.com/kb/110264

Now, this makes sense!  Those of us in varying degrees of migrations to and intergrations with .NET along with AutoLISP could employ a somewhat similar methodology to variable naming.  That way the LISP'ers and the .NET'ers could (sort of) understand each other.

Wait!  But then Matt and I would have to start being consistent!?  I'm not sure my wandering mind is up to that task.

What if we were consistently inconsistent?  That way, we'd still be consistent, but on a different level.   

[SEANT]

Wait a minute; I thought the best way to bolster job security, as well as encourage a relaxed work environment, was to give variables friendly names like Fred, Helga, Spanky, etc.  Isn’t it also recommended to set the same variable to several different names, as a variety enhancement to alleviate boredom?

I actually stole this concept from a hilarious list somewhere that encourages sensible coding techniques by expounding the “virtues” of the opposite.  I don’t suppose anyone has recalls that link?

[Matt__W]

I don’t suppose anyone has recalls that link?

I think this is it

[Lee Mac]

I don’t suppose anyone has recalls that link?

I think this is it.

ahah not funny... I was stuck on that for about 5 mins... keeps jumpin round..

[Matt__W]

I don’t suppose anyone has recalls that link?

I think this is it.

ahah not funny... I was stuck on that for about 5 mins... keeps jumpin round..

Like I said... I THINK this is it.  I wasn't sure.   

[CAB]

I didn't find it a bit funny. 

[mmason]

Wait a minute; I thought the best way to bolster job security, as well as encourage a relaxed work environment, was to give variables friendly names like Fred, Helga, Spanky, etc.  Isn’t it also recommended to set the same variable to several different names, as a variety enhancement to alleviate boredom?

There is also the paranoid programmer's pre-compiled method:

(if (= (+ &*^%$%$#@^&^ !@!#@$%$#%&) &*^%^$@#@$$!*) (princ (strcat %$^#&*!@# ", Spanky"))

[CAB]

Wait a minute; I thought the best way to bolster job security, as well as encourage a relaxed work environment, was to give variables friendly names like Fred, Helga, Spanky, etc.  Isn’t it also recommended to set the same variable to several different names, as a variety enhancement to alleviate boredom?

I actually stole this concept from a hilarious list somewhere that encourages sensible coding techniques by expounding the “virtues” of the opposite.  I don’t suppose anyone has recalls that link?

I did find this: http://www.theswamp.org/index.php?topic=1786.msg22798#msg22798

[SEANT]

I did find this: http://www.theswamp.org/index.php?topic=1786.msg22798#msg22798

That's it.  Even funnier today. 

[Lee Mac]

Wait a minute; I thought the best way to bolster job security, as well as encourage a relaxed work environment, was to give variables friendly names like Fred, Helga, Spanky, etc.  Isn’t it also recommended to set the same variable to several different names, as a variety enhancement to alleviate boredom?

I actually stole this concept from a hilarious list somewhere that encourages sensible coding techniques by expounding the “virtues” of the opposite.  I don’t suppose anyone has recalls that link?

I did find this: http://www.theswamp.org/index.php?topic=1786.msg22798#msg22798

HAHahahah that is brilliant CAB