[thelist] HOT: Documenting PHP code

Steve Cook steve.cook at evitbe.com
Thu Jul 4 03:32:01 CDT 2002

Perhaps OT would have been a better prefix then - although I don't see what
is offtopic with the question anyway - programming question... looks pretty
on-topic to me ;-)

Is this normal you ask. I'm a little confused as to what you mean by normal.
I would suggest that good comments in code explain the intention behind the
code rather than explaining the code itself. Hopefuly the code should be
self-evident. So something like this:

// add $a and $b
$i = $a+$b;

would be unnecessary whilst:

// We need to know how many units we are dealing with to build our loop
$i = $a+$b;

would be (potentially) useful.

Is that more or less what you meant??


 Cookstour - http://cookstour.org

More information about the thelist mailing list