What is wrong with: 
#!/usr/local/bin/perl -w
#
my $foo;

#=================================#
# This piece of code performs the #
# bar transformation according to #
# the algorithm in Chapter 8 of   #
# Knuth.                          #
#=================================#

sub bar {

    local $something = shift;

    # warning - tricky bit of code here
    # fixed on 9 Aug 2000 by KR to avoid 
    # possible divide by 0 situation

    
    return 1;
}

# and so on

[download]
That is the convention we use here, with most languages. Make the comments stand out, and be generous with them.

Ken

In reply to Re: C style comments? by Maclir
in thread C style comments? by Cirollo

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!
  • Titles consisting of a single word are discouraged, and in most cases are disallowed outright.
  • 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, details, 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, summary, 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.