comp.lang.idl-pvwave archive: archive » Re: Comments on Coding Style

Home » Public Forums » archive » Re: Comments on Coding Style

Show: Today's Messages :: Show Polls :: Message Navigator
E-mail to friend

Re: Comments on Coding Style [message #70684 is a reply to message #70675]

Thu, 29 April 2010 06:05

David Fanning
Messages: 11724
Registered: August 2001

Senior Member

Aram Panasenco writes:

> I want your comments on the programming conventions I use and how I can
> change them to make the code more clear and desirable for other
> programmers to improve. Some things to consider:
>
> - Should I use comments or is the code (so far) pretty self-explanatory?
> - Is the non-standard capitalization annoying you? Should I switch to
> the classic IDL capitalization (All-caps for IDL keywords, capitalized
> function and procedure names)?
> - Is there anything wrong with the way I handle the IDL class? The
> routines?
> - Anything wrong at all? I'd rather fix it now than thousands of lines
> of code later.

I like the style, but, yes, you need comments. Lots of
them. :-)

Also, the __DEFINE method has to be the *last* method
in the file, not the first, or you will spend all your
programming time compiling files as if you were programming
in C or something. :-)

http://www.dfanning.com/tips/namefiles.html

Cheers,

David

--
David Fanning, Ph.D.
Fanning Software Consulting, Inc.
Coyote's Guide to IDL Programming: http://www.dfanning.com/
Sepore ma de ni thui. ("Perhaps thou speakest truth.")

Report message to a moderator

[Message index]

		Re: Comments on Coding Style By: David Fanning on Thu, 29 April 2010 13:59
		Re: Comments on Coding Style By: Michael Galloy on Thu, 29 April 2010 13:52
		Re: Comments on Coding Style By: Aram Panasenco on Thu, 29 April 2010 13:17
		Re: Comments on Coding Style By: Aram Panasenco on Thu, 29 April 2010 13:10
		Re: Comments on Coding Style By: David Fanning on Thu, 29 April 2010 12:42
		Re: Comments on Coding Style By: penteado on Thu, 29 April 2010 12:38
		Re: Comments on Coding Style By: Aram Panasenco on Thu, 29 April 2010 12:26
		Re: Comments on Coding Style By: David Fanning on Thu, 29 April 2010 06:05
		Re: Comments on Coding Style By: Maarten[1] on Thu, 29 April 2010 01:44
		Re: Comments on Coding Style By: Aram Panasenco on Thu, 29 April 2010 16:30
		Re: Comments on Coding Style By: Michael Galloy on Thu, 29 April 2010 14:17

Previous Topic:	AO, SAO
Next Topic:	Writing *.csv files

-=] Back to Top [=-

[ Syndicate this forum (XML) ] [

] [

]

Current Time: Fri Oct 10 08:25:09 PDT 2025

Total time taken to generate the page: 0.08098 seconds