phpdoc interface and/or implementing classes
Moderator: General Moderators
phpdoc interface and/or implementing classes
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.
- 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
To document both interface and implementing classes or not?
- 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
I'd say document both because they are different. One is the interface and the other is what is behind it.
(#10850)