RE: Duhvelopers and DB-ehs?

<SOAPBOX>

When I comment code, I always do things like:

# put the value 5 in inta

inta = 5;

# does a loop from 5-33430

for (i=5; i> 33430; i++)
{
..
}

# calls blah3434 function

blah3434();

Just kidding, but it is kinda of a duhvelupur thing to do to always state the obvious, and think there is good comments. Comments like the ones above are completely useless. The following is much better commenting. It is amazing how many times I see comments such as the above. Yet the sections which are truly confusing, are very poorly commented. Comments are much more than just tell you what the step does, it is explaining the methodology. Like Rachel's comments are perfect and totally helpful. A lot of people comment the code for people who do not understand the syntax, not people who do not understand the algorithm. It is pretty safe to say, people who read the source, should have at least fundemental understanding of the syntax of the language.

# Put the number of users to run into inta
inta = 5;

# for each blah found in the blah array, do the following.
for (i=5; i> 33430; i++)
{
..
}

# calls blah3434 function to clean up and to the final work on the items.
blah3434();

"Do not criticize someone until you walked a mile in their shoes, that way when you criticize them, you are a mile a way and have their shoes."

Christopher R. Spence
Oracle DBA
Phone: (978) 322-5744
Fax: (707) 885-2275

Fuelspot
73 Princeton Street
North, Chelmsford 01863  

-----Original Message-----
Sent: Tuesday, September 04, 2001 12:05 PM To: Multiple recipients of list ORACLE-L

NOOOOOOOOOOOOOOO! You comment your code so other people can read it. You rebel you!

=)

-----Original Message-----
Sent: Tuesday, September 04, 2001 10:42 AM To: Multiple recipients of list ORACLE-L

Kevin,

No problem, I believe in sharing (but you notice I removed my database names)... this way, you have the time to write something cool and share it with the rest of us. Reinventing the wheel is a waste of time.

And I always try to write plain vanilla code, and comment it heavily. That way, when I go back to it in 3 months, I can remember what the heck I was doing with it and why.

Rachel

>From: "Thomas, Kevin" <Kevin.Thomas_at_calanais.com>
>Reply-To: ORACLE-L_at_fatcity.com
>To: Multiple recipients of list ORACLE-L <ORACLE-L_at_fatcity.com>
>Subject: RE: Duhvelopers and DB-ehs?
>Date: Tue, 04 Sep 2001 07:15:50 -0800
>
>Rachel,
>
>Thanks a million for that...I'll take the timeout at some point to pour
>over
>it and determine what it's doing...but it looks relatively straight 
>forward.
>
>K.
>
>
>"hit any user to continue"
>__________________
>
>Kevin Thomas
>Technical Analyst
>Deregulation Services
>Calanais Ltd.
>(2nd Floor East - Weirs Building)
>Tel: 0141 568 2377
>Fax: 0141 568 2366
>http://www.calanais.com
>

The information contained in this e-mail is strictly confidential and for the intended use of the addressee only; it may also be legally privileged and/or price sensitive. Notice is hereby given that any disclosure, use or copying of the information by anyone other than the intended recipient is prohibited and may be illegal. If you have received this message in error, please notify the sender immediately by return e-mail.

Corporate Systems, Inc. has taken every reasonable precaution to ensure that any attachment to this e-mail has been swept for viruses. We accept no liability for any damage sustained as a result of software viruses and advise you carry out your own virus checks before opening any attachment.

-- 
Please see the official ORACLE-L FAQ: http://www.orafaq.com
-- 
Author: April Wells
  INET: awells_at_csedge.com

Fat City Network Services    -- (858) 538-5051  FAX: (858) 538-5051
San Diego, California        -- Public Internet access / Mailing Lists
--------------------------------------------------------------------
To REMOVE yourself from this mailing list, send an E-Mail message
to: ListGuru_at_fatcity.com (note EXACT spelling of 'ListGuru') and in the
message BODY, include a line containing: UNSUB ORACLE-L (or the name of
mailing list you want to be removed from).  You may also send the HELP
command for other information (like subscribing).
-- 
Please see the official ORACLE-L FAQ: http://www.orafaq.com
-- 
Author: Christopher Spence
  INET: cspence_at_FuelSpot.com

Fat City Network Services    -- (858) 538-5051  FAX: (858) 538-5051
San Diego, California        -- Public Internet access / Mailing Lists
--------------------------------------------------------------------
To REMOVE yourself from this mailing list, send an E-Mail message
to: ListGuru_at_fatcity.com (note EXACT spelling of 'ListGuru') and in
the message BODY, include a line containing: UNSUB ORACLE-L
(or the name of mailing list you want to be removed from).  You may
also send the HELP command for other information (like subscribing).