From owner-freebsd-hackers Wed Oct 29 20:37:51 1997 Return-Path: Received: (from root@localhost) by hub.freebsd.org (8.8.7/8.8.7) id UAA13196 for hackers-outgoing; Wed, 29 Oct 1997 20:37:51 -0800 (PST) (envelope-from owner-freebsd-hackers) Received: from parkplace.cet.co.jp (parkplace.cet.co.jp [202.32.64.1]) by hub.freebsd.org (8.8.7/8.8.7) with ESMTP id UAA13191 for ; Wed, 29 Oct 1997 20:37:47 -0800 (PST) (envelope-from michaelh@cet.co.jp) Received: from localhost (michaelh@localhost) by parkplace.cet.co.jp (8.8.5/CET-v2.1) with SMTP id EAA18877; Thu, 30 Oct 1997 04:37:07 GMT Date: Thu, 30 Oct 1997 13:37:06 +0900 (JST) From: Michael Hancock To: "John S. Dyson" cc: FreeBSD Hackers Subject: Re: your commentary gripe (was Re: svgalib? (forget the newbies) ) In-Reply-To: <199710300325.WAA20048@dyson.iquest.net> Message-ID: MIME-Version: 1.0 Content-Type: TEXT/PLAIN; charset=US-ASCII Sender: owner-freebsd-hackers@FreeBSD.ORG X-Loop: FreeBSD.org Precedence: bulk On Wed, 29 Oct 1997, John S. Dyson wrote: > Michael Hancock said: > > > > > > specifically here's my gripe with FreeBSD and the XFree86 peoples, COMMENT > > > > YOUR CODE A LITTLE MORE DAMMIT :) > > > > More comments aren't necessarily better. Wrong comments are worse then no > > comments and more comments can lead to that. > > > > If want to rip on something, go thru the cvs logs and rip on useless > > comments. If you want to encourage something push for better meaningful > > comments. > > > It wouldn't be too hard to add comments: > > vp = vp->v_next; /* get the next vp */ > i++; /* add one to i */ > > Hmmm.... :-). Yeah, those should be plucked out of the code. One liners above the code section that describe the author's intent rather than parroting the mechanics of the code is sufficient. The philosophy is pretty well described in "Elements of Style", by Strunk and White. Or better yet, "Elements of Programming Style", by Kernigan and Plauger. Mike Hancock