Re: [OT?] Coding Style

Admin Mailing Lists
2001-01-22T23:21:13Z

>
> Please don't listen to this. The only place you really want comments is
>
> a) at the top of files, describing the point of the file;
> b) at the top of functions, if the purpose of the function is not obvious;
> c) in line, when the code is not obvious.
>
> If you are writing code that requires a comment for every line, you are
> writing bad, obscure, unobvious code and no amount of commenting will fix
> it.
>

or
1) your code-viewing audience is a bunch of 5 year olds
2) the person reading the code isn't a 'qualified' programmer. If they
were, they'd most likely be able to understand the code without
hand-holding of that magnitude. We don't write code for idiots.

-Tony
.-._.-._.-._.-._.-._.-._.-._.-._.-._.-._.-._.-._.-._.-._.-._.-._.-._.-.
Anthony J. Biacco Network Administrator/Engineer
thelittleprince@asteroid-b612.org Intergrafix Internet Services

"Dream as if you'll live forever, live as if you'll die today"
http://www.asteroid-b612.org http://www.intergrafix.net
.-._.-._.-._.-._.-._.-._.-._.-._.-._.-._.-._.-._.-._.-._.-._.-._.-._.-.