Article View: alt.folklore.computers
Article #1167Re: Cryptic comments
From: mal... Sean Malloy
Date: Thu, 01 Feb 1990 05:09
Date: Thu, 01 Feb 1990 05:09
29 lines
2219 bytes
2219 bytes
In article <MERNST.90J...@owl.lcs.mit.edu> mer...@theory.lcs.mit.edu (Michael Ernst) writes:
>I seem to remember a line in the Symbolics garbage-collector source; the
>code was long and convoluted, and it contained but a single comment:
> ; Gute Nacht, mein Wesen
>just before a variable's value was bashed.
When I worked for ITT Courier, one of the things I got to do was make some
modifications to the code for the POS (Point-Of-Sale) systems that the
company was marketing to McDonalds. I grew to loathe the code, simply
because the person who'd developed it (and left) had a radically minimalist
and baroque attitude toward commenting their code.
In a three-page loop of Z80 assembler, there was the single comment line,
"Chunka Chunka". Another loop occupying a page and a half of assembler
dealing with controlling the cost display had the single comment "And it
comes out here". Three-quarters of a page of code dealing with error
recovery was commented "Oops". I learned more about how _not_ to document
my programs then than I did anywhere else, though (as well as winding up
memorizing the explosion table for McDonald's products -- howw much of what
goes into each item on the menu, for inventory tracking).
Sean Malloy |
{hplabs!hp-sdd, akgua, ucsd, nosc}!crash!malloy | "I am here by the will of
ARPA: crash!malloy@nosc | the people, and I will
Navy Personnel Research and Development Center | not leave until I get my
San Diego, CA 92152-6800 | raincoat back."
UUCP: {hplabs!hp-sdd, akgua, ucsd}!nprdc!malloy |
ARPA: mal...@nprdc.navy.mil |
Technical Details
Message-ID:
<1321@crash.cts.com>Path:
mbox-mo1.pugleaf.net!gmdzi!unido!mcsun!sunic!uupsi!rpi!brutus.cs.uiuc.edu!samsung!cs.utexas.edu!swrinde!ucsd!nosc!crash!malloyReferences:
<MERNST.90Jan31200807@owl.lcs.mit.edu>Show Full Headers
Complete Article Headers
Path: mbox-mo1.pugleaf.net!gmdzi!unido!mcsun!sunic!uupsi!rpi!brutus.cs.uiuc.edu!samsung!cs.utexas.edu!swrinde!ucsd!nosc!crash!malloy From: mal...@crash.cts.com (Sean Malloy) Newsgroups: alt.folklore.computers Subject: Re: Cryptic comments Message-ID: <1321@crash.cts.com> Date: 1 Feb 90 05:09:42 GMT References: <MERNST.90Jan31200807@owl.lcs.mit.edu> Reply-To: mal...@crash.cts.com (Sean Malloy) Distribution: alt Organization: Crash TimeSharing, El Cajon, CA Lines: 29 Posted: Thu Feb 1 06:09:42 1990 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 7bit