Beefy Boxes and Bandwidth Generously Provided by pair Networks
"be consistent"

Re: To DEBUG, or to COMMENT. _That_ is the question

by einhverfr (Friar)
on Nov 16, 2013 at 15:34 UTC ( #1062902=note: print w/replies, xml ) Need Help??

in reply to To DEBUG, or to COMMENT. _That_ is the question

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.

  • Comment on Re: To DEBUG, or to COMMENT. _That_ is the question

Log In?

What's my password?
Create A New User
Node Status?
node history
Node Type: note [id://1062902]
and one hand claps...

How do I use this? | Other CB clients
Other Users?
Others making s'mores by the fire in the courtyard of the Monastery: (7)
As of 2017-02-24 10:53 GMT
Find Nodes?
    Voting Booth?
    Before electricity was invented, what was the Electric Eel called?

    Results (354 votes). Check out past polls.