Beefy Boxes and Bandwidth Generously Provided by pair Networks
XP is just a number

Re: I wrote some clever code - can the comment "defuse" it?

by hardburn (Abbot)
on Jun 17, 2003 at 21:51 UTC ( #266654=note: print w/replies, xml ) Need Help??

in reply to I wrote some clever code - can the comment "defuse" it?

I'd treat this bit of code as a black box. In other words, the comment should say what input is expected and what will come out again. The "how" part is left as an exercise to your future self :)

Reasoning : you can't be sure that your comment will make things any more understandable at some point in the future, but with "black box code", you can at least be sure your future self will know how to rewrite that bit, should you feel the need to.

I wanted to explore how Perl's closures can be manipulated, and ended up creating an object system by accident.
-- Schemer

Note: All code is untested, unless otherwise stated

  • Comment on Re: I wrote some clever code - can the comment "defuse" it?

Log In?

What's my password?
Create A New User
Node Status?
node history
Node Type: note [id://266654]
and all is quiet...

How do I use this? | Other CB clients
Other Users?
Others having an uproarious good time at the Monastery: (5)
As of 2017-06-27 10:55 GMT
Find Nodes?
    Voting Booth?
    How many monitors do you use while coding?

    Results (603 votes). Check out past polls.