From owner-cvs-all Sun Jan 31 06:17:10 1999 Return-Path: Received: (from majordom@localhost) by hub.freebsd.org (8.8.8/8.8.8) id GAA04100 for cvs-all-outgoing; Sun, 31 Jan 1999 06:17:10 -0800 (PST) (envelope-from owner-cvs-all@FreeBSD.ORG) Received: from hda.hda.com (hda-bicnet.bicnet.net [209.244.238.132] (may be forged)) by hub.freebsd.org (8.8.8/8.8.8) with ESMTP id GAA04093 for ; Sun, 31 Jan 1999 06:17:06 -0800 (PST) (envelope-from dufault@hda.hda.com) Received: (from dufault@localhost) by hda.hda.com (8.8.5/8.8.5) id JAA21835; Sun, 31 Jan 1999 09:11:16 -0500 (EST) From: Peter Dufault Message-Id: <199901311411.JAA21835@hda.hda.com> Subject: Re: cvs commit: src/sys/kern sys_socket.c kern_exit.c kern_resource.c In-Reply-To: <199901311349.AAA19834@godzilla.zeta.org.au> from Bruce Evans at "Feb 1, 99 00:49:43 am" To: bde@zeta.org.au (Bruce Evans) Date: Sun, 31 Jan 1999 09:11:16 -0500 (EST) Cc: committers@FreeBSD.ORG X-Mailer: ELM [version 2.4ME+ PL25 (25)] MIME-Version: 1.0 Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: 7bit Sender: owner-cvs-all@FreeBSD.ORG Precedence: bulk > >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