**warning, non useful information**

I hear ya Nik.  One of my classic in line comments was:

// The following code does exactly what it looks like it does.

Adam Lang
Systems Engineer
Rutgers Casualty Insurance Company
http://www.rutgersinsurance.com
----- Original Message -----
From: "Nikolai Devereaux" <yomama@u...>
To: "professional php" <pro_php@p...>
Sent: Monday, August 05, 2002 2:25 PM
Subject: [pro_php] RE: calling a php function from javascript function


> There's the kicker -- it really takes the combination of the two.
Extensive
> commenting almost makes the code HARDER to maintain, because developers
(by
> nature) are lazy -- hence the common goal of "efficiency" in our code!  If
> there's a lot of function comments, for example, and a developer updates
the
> function a bit, then they'll have to go through and modify all the
comments
> that mention that particular function accordingly.
>
> I spent an entire week once just rewriting documentation for a good sized
> C++ application framework because we reworked many of the components.
>
> that wasn't fun. =)