Re: Documenting Code Question
| From: | Bogomil Shopov | Date: | Mon, 13 Jun 2005 15:34:23 +0000 |
| Subject: | Re: Documenting Code Question | ||
| References: | 1 | Groups: | php.general |
| Request: | Send a blank email to php-general+get-216892@lists.php.net to get a copy of this message | ||
Hi Cris,
I think object is necessary for PHPDoc standart (or similar);) But a
detailed description of what object contains will be very helpfull.
Unfortunatly you should make it in a separate file.
--
Bogomil B. Shopov
http://purplerain.org
Reply --------------->
Chris Drozdowski wrote:
> 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"?
>
>
> Thanks,
>
> Chris Drozdowski
> c.d@earthlink.net