Re: php Function description standards.
| From: | Firman Wandayandi | Date: | Tue, 11 May 2004 08:52:00 +0000 |
| Subject: | Re: php Function description standards. | ||
| References: | 1 | Groups: | php.pear.general |
| Request: | Send a blank email to pear-general+get-12417@lists.php.net to get a copy of this message | ||
Pete <webmaster@dentona.de> wrote:
> Hello everyone,
>
> could anybody please tell me where I can learn about writing function
> comments for my own projects?
> I checked out some classes of PEAR. Everybody seems to describe the
> functions like this:
>
> /*
> * This function retriesves ...
> * @param country_id
> * @access public
> * @return array
> */
> Is there anything more to it @param, @access,@ return ?
> I would like to find out more about this but I couldn't find anything
about
> it on the PEAR page.
> I was only able to find the 'coding standards'.
>
> Thank you very much.
>
> Webmaster
>
> http://learn.to/quote
>
Hi Pete,
All of that are tags of phpDocumentor (http://www.phpdoc.org/) for generated
API documentation, find out more about that on phpDocumentor documentation.
Regards,
Firman