phpdoc interface and/or implementing classes

Not for 'how-to' coding questions but PHP theory instead, this forum is here for those of us who wish to learn about design aspects of programming with PHP.

Moderator: General Moderators

Post Reply
koen.h
Forum Contributor
Posts: 268
Joined: Sat May 03, 2008 8:43 am

phpdoc interface and/or implementing classes

Post by koen.h »

In order to avoid duplicate phpdocumentation I would only comment the interface. But I have no idea what the standard is. Seems to me that commenting the class itself is indispensible when you need to explain things that are specific to the implementation. But that opens up a lot of duplicate documenting. I've always been a very lazy documentor and am looking to change that.
User avatar
Christopher
Site Administrator
Posts: 13596
Joined: Wed Aug 25, 2004 7:54 pm
Location: New York, NY, US

Re: phpdoc interface and/or implementing classes

Post by Christopher »

And your question is? ;)
(#10850)
koen.h
Forum Contributor
Posts: 268
Joined: Sat May 03, 2008 8:43 am

Re: phpdoc interface and/or implementing classes

Post by koen.h »

To document both interface and implementing classes or not?
User avatar
Christopher
Site Administrator
Posts: 13596
Joined: Wed Aug 25, 2004 7:54 pm
Location: New York, NY, US

Re: phpdoc interface and/or implementing classes

Post by Christopher »

I'd say document both because they are different. One is the interface and the other is what is behind it.
(#10850)
Post Reply