I have had the recent experience of being contracted to do some ad hoc work
on a foxpro printing application. It is scarcely documented in the code and
most comments are useless in that they explain only the obvious. For a
fairly simple application it is unnecessarily complex in its design and I am
struggling to find what goes where. A few comments that explain a few things
would be worth their weight in gold. Some people cannot write a simple
application simply. They seem to need to build this complex structure full
of unnecessary objects and layers and who knows what else just to print a
series of pre-printed forms. I mostly hate that I am finding it difficult to
find my way around it.


-----Original Message-----
From: [email protected] [mailto:[email protected]] On Behalf
Of Jeff Johnson
Sent: Friday, 9 April 2010 7:40 AM
To: [email protected]
Subject: Re: Comments are there too many or should syntax explain it all?

On 4/8/2010 10:33 AM, Stephen Russell wrote:
> Listening to a brown bag lunch and Comments.
>
> What is too much.
>
> Why?
>

A lot of my code is 18 years old and I have had people work for me over 
the years.  When I go back and look at old code I realize where I should 
have used comments.

Also, I use comments to describe what parameters should have been 
passed, the explanation of a complex algorithm.

The main reason for comments is when "so and so" says do "so and so."  I 
document the change in the code.  "Stephen Russell said to eliminate 
database access."



Jeff

Jeff Johnson
[email protected]
SanDC, Inc.
623-582-0323
Fax 623-869-0675

http://www.VetsFindingVets.org



[excessive quoting removed by server]

_______________________________________________
Post Messages to: [email protected]
Subscription Maintenance: http://leafe.com/mailman/listinfo/profox
OT-free version of this list: http://leafe.com/mailman/listinfo/profoxtech
Searchable Archive: http://leafe.com/archives/search/profox
This message: 
http://leafe.com/archives/byMID/profox/[email protected]
** All postings, unless explicitly stated otherwise, are the opinions of the 
author, and do not constitute legal or medical advice. This statement is added 
to the messages for those lawyers who are too stupid to see the obvious.

Reply via email to