Beefy Boxes and Bandwidth Generously Provided by pair Networks
Perl: the Markov chain saw

Re: Why no comments?

by shmem (Chancellor)
on Jan 31, 2009 at 11:29 UTC ( #740408=note: print w/replies, xml ) Need Help??

in reply to Why no comments?

Comments in code are for maintainers. They point out parts which need fixing, lay out assertions on which the current piece of code relies, explain unusual constructs and point out side-effects upon other parts far away. Sometimes they refer to a bug ticket. A maintainer has the skills to understand the code without third party help, and comments which explain the code further than that are annoying and obscuring the fact to her.

All other comments on the code live in the documentation, and in the skill of teachers. See also the thread An Introduction to Literate Programming with perlWEB which also discusses the use of comments.

Log In?

What's my password?
Create A New User
Node Status?
node history
Node Type: note [id://740408]
and the web crawler heard nothing...

How do I use this? | Other CB clients
Other Users?
Others pondering the Monastery: (6)
As of 2019-10-23 21:15 GMT
Find Nodes?
    Voting Booth?