Skip site navigation (1)Skip section navigation (2)
Date:      Sun, 31 Jan 1999 09:11:16 -0500 (EST)
From:      Peter Dufault <dufault@hda.com>
To:        bde@zeta.org.au (Bruce Evans)
Cc:        committers@FreeBSD.ORG
Subject:   Re: cvs commit: src/sys/kern sys_socket.c kern_exit.c kern_resource.c
Message-ID:  <199901311411.JAA21835@hda.hda.com>
In-Reply-To: <199901311349.AAA19834@godzilla.zeta.org.au> from Bruce Evans at "Feb 1, 99 00:49:43 am"

next in thread | previous in thread | raw e-mail | index | archive | help
> >so when did comments start hurting?
> 
> >From the beginning.  Kernighan and Plauger, in "The Elements of
> Progamming Style", second edition (1984) give many reasons in the
> index alone:
> 
>     comments, agreement of code and  142
>     comments, excessive  104, 151
>     comments, incorrect  70, 88, 142, 143, 151
>     comments, subconcious acceptance of  142
>     comments, useless  142

>From my 1978 copy these boil down to the following three aphorisms:

Make sure comments and code agree
Don't over-comment
Don't just echo the code with comments - make every comment count

Peter

-- 
Peter Dufault (dufault@hda.com)   Realtime development, Machine control,
HD Associates, Inc.               Safety critical systems, Agency approval

To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe cvs-all" in the body of the message



Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?199901311411.JAA21835>