| lsmith@php.net 2006-07-21, 3:57 am |
| ID: 34789
Updated by: lsmith@php.net
Reported By: lsmith@php.net
Status: Open
Bug Type: Documentation problem
Operating System: irrlevant
PHP Version: Irrelevant
New Comment:
OK, I think I have phpdoc karma. However I do not have a way to test
changes, nor experience with phpdoc (though I am sure I will be able to
figure out the xml syntax). I would however like to add the updated
document. How should I best go about doing this? Where should I add the
document?
Previous Comments:
------------------------------------------------------------------------
[2005-11-25 13:01:55] lsmith@php.net
I have begun writing a guide over here:
http://oss.backendmedia.com/UserlandNamingGuide
------------------------------------------------------------------------
[2005-11-25 09:57:37] lsmith@php.net
actually we probably need to say that anything that goes into the
global namespace needs to be prefixed by a fairly random (hopefully
unique within the php community) 3-4 letter prefix or breakage is to be
expected ..
see the recent issues with the File and Date objects
------------------------------------------------------------------------
[2005-10-13 11:49:53] vrana@php.net
In language/oop.xml is already mentioned this:
"PHP reserves all function names starting with __ as magical. It is
recommended that you do not use function names with __ in PHP unless
you want some documented magic functionality."
------------------------------------------------------------------------
[2005-10-08 12:51:58] lsmith@php.net
Description:
------------
We need a guide that explains users how to name their userland
functions, classes, exceptions etc without conflicting with future
versions of php (or atleast keeping the risk low) ..
so we will state the obvious like that we usually prefix extension
stuff with the name of the extensions .. but also that we postfix
iterators and exceptions with "Iterator" and "Exception" ..
------------------------------------------------------------------------
--
Edit this bug report at http://bugs.php.net/?id=34789&edit=1
|