I'm somewhat enamored of the Smart::Comments module, but have found several shorcomings not mentioned above:

  1. It stops Perl's debugger from performing Run (R) commands for some reason. I have not researched this at all, but have definitely seen that (R) will run your code until the next breakpoint or the next Smart::Comment (sigh).
  2. You can print VARB or LABEL:VARB, but you can't print arbirary strings containing VARBs, such as 
                    ### $0 starting
                ### $var of $var
                ### $var $var
  3. YOU CANNOT have a colon in your Smart comments - the following would cause compile to fail!
                    ## this is record $var: all is well
  4. In-line SMARTCOMMENTS (meaning those to the right of code) do not seem to work. They only work on loops progress bars. 
                    $var++;  ### $var
                ### Did you get that? No, you didn't.

{}think; #Think outside of the brackets

In reply to Re: In Defense of Smart::Comments by {}think
in thread In Defense of Smart::Comments by Xiong

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.