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 #70693 is a reply to message #70684]

Thu, 29 April 2010 01:44

Maarten[1]
Messages: 176
Registered: November 2005

Senior Member

On Apr 29, 8:26 am, Aram Panasenco <panasencoa...@gmail.com> wrote:

> 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?

Always add a description of hte intention of the code. Not the trivial
bits ("increment var by 1" is pointless, adding a comment _why_ var is
incremented can save you a lot of headaches). This code was not self-
explanatory for me.

> - 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)?

I'm more annoyed by the over-capitalization of classic IDL. All-caps
is like shouting all the time, and at some point I stop listening. An
editor with syntax coloring is more valuable, and a code index is even
better. Don't do yourself what a computer can do better.

Maarten

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 04:05:05 PDT 2025

Total time taken to generate the page: 1.92496 seconds