phpdoc conventions on methods
| From: | Stanislav Malyshev | Date: | Thu, 16 Aug 2007 01:19:22 +0000 |
| Subject: | phpdoc conventions on methods | ||
| Groups: | php.doc | ||
| Request: | Send a blank email to phpdoc+get-969377366@lists.php.net to get a copy of this message | ||
What are the standards/conventions on the following matters:
1. Method names in reference.xml (when descripting class) - should I use class->method or class->method() (with or without braces)? I see both - compare PDO and DOM docs.
2. Function names in function description (refname) - with or without braces? I see most of the functions don't have braces in names.
3. Same for method name - dominant use seems to be with braces though some don't use braces - see SPL or SDO docs for example.
4. Should one use class name in method description in reference.xml - is it Class->method or just method? DOM uses class, PDO doesn't. SPL doesn't have the section at all...
5. Should method use Class::method or Class->method? SPL uses ::, PDO uses ->.
--
Stanislav Malyshev, Zend Software Architect
stas@zend.com http://www.zend.com/
(408)253-8829 MSN: stas@zend.com