Message-ID: <352052E2.3B37AC41@Golux.Com>
Date: Mon, 30 Mar 1998 21:20:18 -0500
From: Rodent of Unusual Size <Ken.Coar@Golux.Com>
Organization: The Apache Group
MIME-Version: 1.0
To: new-httpd@apache.org
Subject: Re: cvs commit: apache-1.3/src/modules/standard mod_expires.c
References: <199803301329.IAA12865@devsys.jaguNET.com>
Content-Type: text/plain; charset=us-ascii
Content-Transfer-Encoding: 7bit
Sender: new-httpd-owner@apache.org
Precedence: bulk
Reply-To: new-httpd@apache.org

Jim Jagielski wrote:
> 
> For that reason, I'm a firm believer in source-code comments and
> tend to go overboard with them. However, I've too many times
> "inherited" code that lacked any documentation and it makes
> maintaining/porting/updating it a total pain. Sure you can see _what_
> the code is doing, but not _why_ :/
> 
> With the size that Apache is, I think we need all 3: source code comments,
> some logical naming scheme and "regular" docs. The naming scheme
> needs work... this should be obvious to all of us.

+1

Of course the formal documentation lags; none of really wants to
be a tech writer (he says, of a group with at least four authors
in it ;-).  I misunderstood Dean's remark to mean the docco should
exist *only* in the source.

Well-documented source first, by all means.

#ken	P-)}

Ken Coar                    <http://Web.Golux.Com/coar/>
Apache Group member         <http://www.apache.org/>
"Apache Server for Dummies" <http://WWW.Dummies.Com/