in reply to Ways of commenting subroutines
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#***<StringToArray>************************************************* # Purpose: Combine 2 strings into 1 array # # Inputs : 2 strings # # Outputs: 1 array # # Programmer Date Comments # --------------- -------- -------- # Bob Smith 03/30/01 Created #******************************************************
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.
sincerely Shadowfax
"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
|
---|
Replies are listed 'Best First'. | |
---|---|
Re: Re: Ways of commenting subroutines
by willdooUK (Beadle) on Mar 29, 2001 at 17:47 UTC | |
by Shadowfax (Sexton) on Mar 29, 2001 at 20:57 UTC | |
by willdooUK (Beadle) on Mar 29, 2001 at 21:34 UTC | |
by tilly (Archbishop) on Mar 30, 2001 at 03:57 UTC | |
by Shadowfax (Sexton) on Mar 30, 2001 at 20:42 UTC | |
by tilly (Archbishop) on Mar 30, 2001 at 21:50 UTC | |
by MeowChow (Vicar) on Mar 31, 2001 at 00:22 UTC | |
by demerphq (Chancellor) on Oct 23, 2001 at 17:47 UTC |
In Section
Seekers of Perl Wisdom