Beefy Boxes and Bandwidth Generously Provided by pair Networks
Clear questions and runnable code
get the best and fastest answer
 
PerlMonks  

Re: flower box comments

by Itatsumaki (Friar)
on Nov 17, 2003 at 06:33 UTC ( #307577=note: print w/replies, xml ) Need Help??


in reply to flower box comments

A lot of monks here (and good programmers in general) favour terse comments directly in the code, along with substantial POD. They likely have the same doubts you do.

I've used a style much like that for a long time, though. I was first exposed to it in a C-shop, and I have seen several advantages with it:

  • Maintenance programmers don't have to read code for every sub
  • Explicitly states the contract for a function/method
  • Leaves room for prose (e.g. ToDo lists, caveats the programmer notes, modification histories for non-CVS environments)
  • Clearly separates methods and routines from one another
  • Clearly separates general comments from comments about specific lines of code

That said, the better I get at Perl programming, the more my comments tend towards brevity, so I'm pretty sure those wiser monks who dislike this style are on to something.

-Tats

Log In?
Username:
Password:

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

How do I use this? | Other CB clients
Other Users?
Others chilling in the Monastery: (2)
As of 2020-07-13 01:53 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found

    Notices?