Great Circle Associates Majordomo-Workers
(November 1996)
 

Indexed By Date: [Previous] [Next] Indexed By Thread: [Previous] [Next]

Subject: Re: Coding style
From: "Vincent D. Skahan" <vds7789 @ hps12 . iasl . ca . boeing . com>
Date: Tue, 26 Nov 1996 06:03:23 -0800 (PST)
To: Brent @ GreatCircle . COM (Brent Chapman)
Cc: david_wolfe @ risc . sps . mot . com, tibbs @ hpc . uh . edu, brozen @ webdreams . com, cwilson @ neu . sgi . com, majordomo-workers @ greatcircle . com
In-reply-to: <v0300780caebd38518598@[198.102.244.42]> from "Brent Chapman" at Nov 23, 96 03:35:53 pm
Reply-to: vds7789 @ hps12 . iasl . ca . boeing . com

(Brent Chapman writes:)
> In all seriousness, though, there is a code maintenance principle that,
> when working on existing programs, you code in the style they were written
> in, even if that's not precisely your own style.  Introducing new styles
> only serves to confuse folks who come along later, and don't know the new
> code from the old.  This applies to all sorts of things; control constructs
> like those mentioned above, variable naming, variable scoping, use of
> globals, function naming, package organization, indenting conventions,
> commenting conventions, ...  Consistency in all these "style issues" makes
> code easier to maintain.
> 

For a nice example of a nicely written style guide, check out the one 
for Tcl/TK available at ftp://ftp.sunlabs.com/pub/tcl/engManual.tar.Z

You might (or might not) agree with it, but it's certainly clear what
the author wanted to see.

-- 
 ----------- Vince Skahan ------ vds7789@aw101.iasl.ca.boeing.com -----------
  Mad topics slow cleverness
                         - anagram for "World Class Competiveness" sayeth
	                      http://www.genius2000.com/anagram.html


Follow-Ups:
References:
Indexed By Date Previous: Re: 1.94.1 comments
From: Jason L Tibbitts III <tibbs@hpc.uh.edu>
Next: Re: Coding style
From: Dave Wolfe <dwolfe@risc.sps.mot.com>
Indexed By Thread Previous: Re: Coding style
From: Jason L Tibbitts III <tibbs@hpc.uh.edu>
Next: Re: Coding style
From: Dave Wolfe <dwolfe@risc.sps.mot.com>

Google
 
Search Internet Search www.greatcircle.com