From: "M." <me@home.xx>
Subject: Re: Comments (was: Self-referential types)
Date: 1999/10/23
Date: 1999-10-23T00:00:00+00:00 [thread overview]
Message-ID: <XDbQ3.238$wU3.134577@ratbert.tds.net> (raw)
In-Reply-To: 380F2BA5.1EEE15F1@ftw.rsc.raytheon.com
Wes Groleau wrote in message <380F2BA5.1EEE15F1@ftw.rsc.raytheon.com>...
>My own view is comments like the following are worse than
>unnecessary, they are pure clutter:
>
> -- check whether the current transaction is completed
> if Is_Completed (Current_Transaction) then
>
> -- if so, close the source and destination DB files
> DB_IO.Close (Source);
> DB_IO.Close (Destination);
These are rather benign examples of what I call "duh" comments. In other
cases, the names are not so descriptive, and the comments refer to these
names, making them especially useless. e.g.:
-- Add 2 to st
st := st + 2;
-- Flibber the Gibbet
Flibber(Gibbet);
Such comments can arise when the programmer writes the comments first, then
the code. This is a good practice IF the programmer uses it to establish
the semantic requirements of the code, so that it will be easier to write
(and maintain) code that implements them. "Duh" comments defeat this
purpose by blurring the distinction between semantic requirements and
implementation.
M.
next prev parent reply other threads:[~1999-10-23 0:00 UTC|newest]
Thread overview: 62+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <7ttb4a$8mq$1@nnrp1.deja.com>
[not found] ` <3802597B.9205AEE8@averstar.com>
1999-10-12 0:00 ` Self-referential types Ted Dennison
1999-10-12 0:00 ` Matthew Heaney
1999-10-13 0:00 ` Ted Dennison
1999-10-12 0:00 ` Vladimir Olensky
1999-10-12 0:00 ` Matthew Heaney
1999-10-12 0:00 ` Robert I. Eachus
1999-10-12 0:00 ` Matthew Heaney
1999-10-13 0:00 ` Vladimir Olensky
1999-10-13 0:00 ` Vladimir Olensky
1999-10-18 0:00 ` Robert Dewar
1999-10-18 0:00 ` Laurent Guerby
1999-10-18 0:00 ` Vladimir Olensky
1999-10-13 0:00 ` Ted Dennison
1999-10-13 0:00 ` Matthew Heaney
1999-10-13 0:00 ` Robert I. Eachus
1999-10-13 0:00 ` Brian Rogoff
1999-10-15 0:00 ` Robert I. Eachus
1999-10-15 0:00 ` Marin David Condic
1999-10-15 0:00 ` Robert I. Eachus
1999-10-18 0:00 ` Robert Dewar
1999-10-19 0:00 ` Robert I. Eachus
1999-10-18 0:00 ` Robert Dewar
1999-10-18 0:00 ` Ed Falis
1999-10-19 0:00 ` Robert Dewar
1999-10-18 0:00 ` Brian Rogoff
[not found] ` <7u86su$o5v$1@nntp8.atl.mindspring.net>
1999-10-18 0:00 ` Robert I. Eachus
1999-10-22 0:00 ` Richard D Riehle
1999-10-22 0:00 ` Robert I. Eachus
[not found] ` <slrn80fl9f.68j.aidan@skinner.demon.co.uk>
1999-10-19 0:00 ` Wes Groleau
1999-10-21 0:00 ` Robert Dewar
1999-10-21 0:00 ` Jean-Pierre Rosen
1999-10-21 0:00 ` Robert Dewar
1999-10-21 0:00 ` Larry Kilgallen
1999-10-21 0:00 ` Comments (was: Self-referential types) Wes Groleau
1999-10-21 0:00 ` Ehud Lamm
1999-10-22 0:00 ` Ted Dennison
1999-10-23 0:00 ` Ehud Lamm
1999-10-23 0:00 ` Robert Dewar
1999-10-23 0:00 ` Ehud Lamm
1999-10-23 0:00 ` Comments Georg Bauhaus
1999-10-24 0:00 ` Comments Ehud Lamm
1999-10-26 0:00 ` Comments Robert I. Eachus
1999-10-28 0:00 ` Comments Jerry van Dijk
1999-10-28 0:00 ` Comments Ted Dennison
1999-10-25 0:00 ` Comments (was: Self-referential types) Wes Groleau
1999-10-23 0:00 ` M. [this message]
[not found] ` <Pine.A41.3.96-heb-2.07.991021191504.30582K-100000@pluto.mscc.huji. <381477c9.e1388ff3@ftw.rsc.raytheon.com>
1999-10-25 0:00 ` Larry Kilgallen
1999-10-22 0:00 ` Self-referential types Richard D Riehle
1999-10-23 0:00 ` Robert A Duff
1999-10-23 0:00 ` Richard D Riehle
1999-10-24 0:00 ` Michel DELARCHE
1999-10-12 0:00 ` Ted Dennison
1999-10-12 0:00 ` Matthew Heaney
1999-10-12 0:00 ` Richard D Riehle
1999-10-12 0:00 ` news.oxy.com
1999-10-12 0:00 ` Ted Dennison
1999-10-12 0:00 ` Stanley R. Allen
1999-10-13 0:00 ` Ted Dennison
1999-10-13 0:00 ` Vladimir Olensky
1999-10-14 0:00 ` Multiple Inheritance in Ada 95 [was Re: Self-referential types] Tucker Taft
1999-10-12 0:00 ` Self-referential types Matthew Heaney
1999-10-12 0:00 ` Robert A Duff
replies disabled
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox