Beefy Boxes and Bandwidth Generously Provided by pair Networks
Pathologically Eclectic Rubbish Lister
 
PerlMonks  

Re: Ways of commenting subroutines

by jeroenes (Priest)
on Mar 28, 2001 at 15:51 UTC ( [id://67798]=note: print w/replies, xml ) Need Help??


in reply to Ways of commenting subroutines

tilly and others heartily recommended Code Complete. I just have started reading it, and I must say it has quite something to say on the subject of commenting. There is more to it than meets the eye, apparently.

Jeroen
"We are not alone"(FZ)

Replies are listed 'Best First'.
Re: (Code Complete Good But Aged) Ways of commenting subroutines
by buzzcutbuddha (Chaplain) on Mar 31, 2001 at 01:15 UTC
    I have read Code Complete, and I agree it raises some good points,
    but seeing as I don't know Pascal (which most of the examples are in)
    I find reading the book really frustrating.
    I wish he would update the book with some examples from Perl and Java.

    UPDATE:
    Maybe explaining what I meant would be good, since I am still get voted -- on this
    ack!

    I think that what Code Complete has to say regarding commenting, and construction of code to be well said, and
    still applicable.

    But there are portions of the book, especially Design, where the material Steve McConnell presents
    feels dated to me. I don't know Pascal, so talking about the merits of it as a language in his examples
    does not elucidate his discussion.

    Further, Steve McConnell spends a long portion of his discussion in design talking about modules, when I prefer functions.

    Basically I rubbed some people with my opinion and if I did, so be it. I'll take my drubbing, but it's my opinion
    and I'm not going to change it because this book holds a revered place in some people's libraries.

    I still wish he'd update his examples with some from Java or Perl.

Log In?
Username:
Password:

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

How do I use this?Last hourOther CB clients
Other Users?
Others examining the Monastery: (5)
As of 2024-04-18 06:29 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found