File Naming Convention
| From: | Sean Coates | Date: | Mon, 06 Dec 2004 20:27:37 +0000 |
| Subject: | File Naming Convention | ||
| Groups: | php.pear.doc php.pear.qa | ||
| Request: | Send a blank email to pear-qa+get-2080@lists.php.net to get a copy of this message | ||
Hello,
See below for a small patch to the coding standards manual chapter.
This came up from: http://pear.php.net/bugs/bug.php?id=24 (I noticed that there's no clear direction in the PEAR manual).
I'm normally a phpdoc guy, so if this isn't up to your docbook standards, please let me know.
Also, CCed PEAR-QA, at Helgi's request, in case they'd like to do something different regarding filenames.
--
S
ndex: standards.xml
===================================================================
RCS file: /repository/peardoc/en/chapters/standards.xml,v
retrieving revision 1.26
diff -u -r1.26 standards.xml
--- standards.xml 12 Jun 2004 15:50:06 -0000 1.26 +++ standards.xml 6 Dec 2004 20:24:03 -0000@@ -400,6 +400,14 @@
</tgroup>
</informaltable>
</para>
+ <note>
+ <simpara>
+ Files should be named after the class they define. For example, a
+ class named <literal>Foo_Bar</literal> would be defined in
+ <literal>Bar.php</literal>, located in
+ <literal>[PEAR-root]/Foo/</literal>.
+ </simpara>
+ </note>
</sect2>
<sect2>
<title>Functions and Methods</title>