Re: Line-by-line commenting in source code

["David A Parnin" <daparnin@xxxxxxxxxxxxxxxxxx>]

James,

No, it's just you.  :)  Actually, long ago I got in the habit of putting
"That's all folks!" at the end of the program such as just before setting
on LR in RPG.  Other than that, no.  I have seen verbose comments where the
original coder when off on a rant about this or that.  Still, a lot of
times comments are like road signs in the desert--few and far between.

<soapbox>
As far as commenting in general I've noticed that far too many commercial
and even a good number of in-house programs are sparse on comments as to
what (and why) the code is doing.  Heck, I even forget what my own code
does sometimes unless I write more than a two or three word description.
Why not do a sentence or two if warranted?  In the grand scheme of things
they don't take up *that* much space.
</soapbox>

Dave Parnin
Nishikawa Standard Company
Topeka, IN  46571
daparnin@xxxxxxxxxxxxxxxxxx




                                                                                
                              
                      James H H Lampert                                         
                              
                      <jamesl@xxxxxxxxx        To:       
midrange-l@xxxxxxxxxxxx@SMTP@CTB                     
                      om>                      cc:                              
                              
                                               Subject:  Line-by-line 
commenting in source code               
                      02/25/2004 07:15                                          
                              
                      PM                                                        
                              
                      Please respond to                                         
                              
                      Midrange Systems                                          
                              
                      Technical                                                 
                              
                      Discussion                                                
                              
                      <midrange-l@midra                                         
                              
                      nge.com>                                                  
                              
                                                                                
                              
                                                                                
                              



Am I the only one who, when line-by-line comments (either RPG or MI) start
to form a sentence with a few words on each line, finishes out the series
of comments with a line that simply says, "Burma Shave"?

Does anybody else have quirky little bits of comic relief in the source
code? Like my tendency to put allusions to Jadzia or Ezri Dax into the
comments on code that deals with JOINED files? Or a colleague, who was a
real fan of "Buffy the Vampire Slayer," naming some input or output buffer
"BUFFY"?

--
JHHL


_______________________________________________
This is the Midrange Systems Technical Discussion (MIDRANGE-L) mailing list
To post a message email: MIDRANGE-L@xxxxxxxxxxxx
To subscribe, unsubscribe, or change list options,
visit: http://lists.midrange.com/mailman/listinfo/midrange-l
or email: MIDRANGE-L-request@xxxxxxxxxxxx
Before posting, please take a moment to review the archives
at http://archive.midrange.com/midrange-l.