Beefy Boxes and Bandwidth Generously Provided by pair Networks
Don't ask to ask, just ask
 
PerlMonks  

Comment on

( #3333=superdoc: print w/ replies, xml ) 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:
#***<StringToArray>************************************************* # Purpose: Combine 2 strings into 1 array # # Inputs : 2 strings # # Outputs: 1 array # # Programmer Date Comments # --------------- -------- -------- # Bob Smith 03/30/01 Created #******************************************************
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.

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


In reply to Re: Ways of commenting subroutines by Shadowfax
in thread Ways of commenting subroutines by stephen

Title:
Use:  <p> text here (a paragraph) </p>
and:  <code> code here </code>
to format your post; it's "PerlMonks-approved HTML":



  • Posts are HTML formatted. Put <p> </p> tags around your paragraphs. Put <code> </code> tags around your code and data!
  • Read Where should I post X? if you're not absolutely sure you're posting in the right place.
  • Please read these before you post! —
  • Posts may use any of the Perl Monks Approved HTML tags:
    a, abbr, b, big, blockquote, br, caption, center, col, colgroup, dd, del, div, dl, dt, em, font, h1, h2, h3, h4, h5, h6, hr, i, ins, li, ol, p, pre, readmore, small, span, spoiler, strike, strong, sub, sup, table, tbody, td, tfoot, th, thead, tr, tt, u, ul, wbr
  • You may need to use entities for some characters, as follows. (Exception: Within code tags, you can put the characters literally.)
            For:     Use:
    & &amp;
    < &lt;
    > &gt;
    [ &#91;
    ] &#93;
  • Link using PerlMonks shortcuts! What shortcuts can I use for linking?
  • See Writeup Formatting Tips and other pages linked from there for more info.
  • Log In?
    Username:
    Password:

    What's my password?
    Create A New User
    Chatterbox?
    and the web crawler heard nothing...

    How do I use this? | Other CB clients
    Other Users?
    Others surveying the Monastery: (12)
    As of 2015-07-03 12:03 GMT
    Sections?
    Information?
    Find Nodes?
    Leftovers?
      Voting Booth?

      The top three priorities of my open tasks are (in descending order of likelihood to be worked on) ...









      Results (51 votes), past polls