PHP GENERAL 13 RE PHP NEW TO PHP
Date: Tue, 8 Jul 2003 11:11:11 -0400

Subject: Re: [PHP] New to PHP
From: steve@no-spam (Steve Magruder)

Mike Ford wrote:
>> -----Original Message-----
>> From: Jeff Harris [mailto:jharris@no-spam >> Sent: 07 July 2003 23:27
>>
>> After coding for a while, I would suggest that while you're reading >> through coding excercises, you find a coding style that works >> for you and >> keep it consistant. One of the least fun parts of creating >> your php pages >> is reading some code that you coded months (years) ago, and >> it's totally >> out of style with everything else that you're doing.
>
> H'mm, yes -- reminds me of the following, which someone taught me in > the dim-and-distant past and I'm constantly quoting to people who > don't adequately comment code:
>
> "Someone else's code: code written by someone else, or code written > by you more than 6 months ago".

And the corollary to is: Most of what constitutes value in commented code is the code itself, which exhibits well-named variables, methods, etc. and well-structured, well-encapsulated algorithms. When code is structured appropriately, then the only actual comments needed are to explain unusual logic or business rules that cannot be easily deciphered from reading the code.

Steve --
Steve Magruder Consulting - http://consulting.stevemagruder.com