To be honest, I think something like Smart::Comments is downright dangerous. I have run into the anti-pattern of comments that do more than just sit there, and I have never ends well. While I understand these comments can just sit there. However, the idea of embedding programming logic in comments is something which brings back bad memories.

More specifically it is way too easy to mistake a smart comment for a regular one or accidently write one. And it complicates reading comments. Good code is well documented with POD and sparsely commented but the comments themselves are an important part of the discourse about the code. One reads them and gets insight for why the programmer made this choice or that. One might explain why an unexpected structure exists, or why a given value is hardcoded. Adding a programming language to a subset of comments cannot help but interfere with that process. So comments as discussion about the code are valuable and this seems like it would dilute that value.

For those reasons I would never use that module. I think debugging logic is always cleaner even if the instrumentation poses some overhead.

In reply to Re: To DEBUG, or to COMMENT. _That_ is the question by einhverfr
in thread To DEBUG, or to COMMENT. _That_ is the question by taint

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.