Naming schemes

From: Date: Mon, 12 Nov 2001 03:09:58 +0000
Subject: Naming schemes
Groups: php.pear.dev 
Request: Send a blank email to pear-dev+get-2828@lists.php.net to get a copy of this message
I think we've pretty much agreed to disagree about the PEAR naming convention. As of this moment, our coding standards dictates the naming system to be used throughout PEAR. Because it is an official coding standard, all PEAR code must follow it. That's the reason for standards, so as long as that document exists, no one should be questioning the standard. End of discussion. Now, on to the heart of the matter. People don't like the current standard, so the discussion should be about changing the standard. Some background: I'm probably the most responsbile person here for the majority of the PEAR standards. If you trace the history, you'll find the the PEAR coding standards are basically the Horde CODING_STANDARDS document, which Chuck and I put together some time ago. The PEAR community is obviously larger and more diverse than our little Horde project, so perhaps such stringent standards are inappropriate. So, at this point, I really don't think we're being productive arguing about standards. Let's just drop the naming requirement from the coding standards document and be done with the issue. Attached is my proposed change to the PEAR coding standards document. -- Jon Parise (jon@csh.rit.edu) . Information Technology (2001) http://www.csh.rit.edu/~jon/ : Computer Science House Member

Index: standards.xml =================================================================== RCS file: /repository/phpdoc/en/pear/standards.xml,v retrieving revision 1.14 diff -u -r1.14 standards.xml --- standards.xml 10 Nov 2001 21:49:43 -0000 1.14 +++ standards.xml 12 Nov 2001 03:08:57 -0000 @@ -353,26 +353,6 @@ <sect2> <title>Functions and Methods</title> <para> - Functions and methods should be named using the "studly caps" - style (also referred to as "bumpy case" or "camel caps"). - Functions should in addition have the package name as a prefix, - to avoid name collisions between packages. The initial letter of - the name (after the prefix) is lowercase, and each letter that - starts a new "word" is capitalized. Some examples: - <informaltable> - <tgroup cols="3"> - <tbody> - <row> - <entry><simpara>connect()</simpara></entry> - <entry><simpara>getData()</simpara></entry> - <entry><simpara>buildSomeWidget()</simpara></entry> - <entry><simpara>XML_RPC_serializeData()</simpara></entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - <para> Private class members (meaning class members that are intented to be used only from within the same class in which they are declared; PHP does not yet support truly-enforceable private
« previous php.pear.dev (#2828) next »