|Keep It Simple, Stupid|
Re: Ways of commenting subroutinesby Shadowfax (Sexton)
|on Mar 29, 2001 at 01:23 UTC||Need Help??|
i use a modified version of the microsoft flowerboxes
used in Visual BASIC standards. i include the name of
the finction in the top line and it's kinda obvious what
else i do.
i chose this method since the whole thing is easy to read,
easy to modify, and contains all the info you could really
ask for as a person walking into my code. it is usually
more detailed than this, but in the interest of space:
as for the comment to write clear code and not
complex/hard to understand/ blah blah blah:
i do not believe that clear or obvious code is
always the best answer to the problem. sometimes
a difficult to see or downright ugly answer is the
perfect trick. if you only write clear code, then
good luck with unclear problems.
"A computer is almost human - except that it does not blame its mistakes on another computer."
Edited Wed Oct 17 23:37:54 2001 - Footpad