[wp-hackers] Inline Documentation Effort was a Failure

Eric Marden wp at xentek.net
Sat May 24 05:54:09 GMT 2008


> I believe this might be because many of the core developers do not use
> a full fledged IDE for developing PHP code. This is just a guess on my
> part, but a lot of the people I know who edit PHP use editors that are
> essentially little more than text editors with syntax coloring.
>
> I've recently starting using the Eclipse PDT for editing and creating
> PHP projects, and find that use of full out IDEs like this makes it
> not only much easier to add inline documentation, but it gives you a
> valid reason to do so as well.

Bingo. It only provides a benefit if you can get one while coding. And  
it can be awesome, but you have to treat it like Writing Unit Tests -  
write the phpdoc blocks first, then code. It helps make you think your  
code though thoroughly.

-e




More information about the wp-hackers mailing list