Posted by Matthew Weier O'Phinney on 06/13/05 19:53

* Chris Drozdowski <c.d@earthlink.net>:
> I need some help regarding documenting code. Say you have a
> function/method that takes an object as a parameter and/or returns an
> object.
>
> When documenting, do you specify the specific class of the object when
> listing the datatype in the docblock @param and @return specs or do you
> simply specify "object"?

You should mention that this has to do with PhpDocumentor... :-)

The documentation for PhpDoc says that you can specify either 'object'
or the classname of the object's type that is expected. If the class is
in your documentation tree, then it will even link to that class'
documentation; if not, it shows it statically.

I tend to go with the class name, as it gives more information to the
individual reading the documentation.

--
Matthew Weier O'Phinney | WEBSITES:
Webmaster and IT Specialist | http://www.garden.org
National Gardening Association | http://www.kidsgardening.com
802-863-5251 x156 | http://nationalgardenmonth.org
mailto:matthew@garden.org | http://vermontbotanical.org

• Next in forum: Re: [PHP] include()
• Prev in forum: Re: include()
• Thread view: Re: Documenting Code Question

[Reply to this message]