Initial Commit
This commit is contained in:
@@ -0,0 +1,24 @@
|
||||
<documentation title="Including Code">
|
||||
<standard>
|
||||
<![CDATA[
|
||||
Anywhere you are unconditionally including a class file, use <em>require_once</em>. Anywhere you are conditionally including a class file (for example, factory methods), use <em>include_once</em>. Either of these will ensure that class files are included only once. They share the same file list, so you don't need to worry about mixing them - a file included with <em>require_once</em> will not be included again by <em>include_once</em>.
|
||||
]]>
|
||||
</standard>
|
||||
<standard>
|
||||
<![CDATA[
|
||||
Note that <em>include_once</em> and <em>require_once</em> are statements, not functions. Parentheses should not surround the subject filename.
|
||||
]]>
|
||||
</standard>
|
||||
<code_comparison>
|
||||
<code title="Valid: used as statement">
|
||||
<![CDATA[
|
||||
require_once 'PHP/CodeSniffer.php';
|
||||
]]>
|
||||
</code>
|
||||
<code title="Invalid: used as function">
|
||||
<![CDATA[
|
||||
require_once<em>(</em>'PHP/CodeSniffer.php'<em>)</em>;
|
||||
]]>
|
||||
</code>
|
||||
</code_comparison>
|
||||
</documentation>
|
||||
@@ -0,0 +1,7 @@
|
||||
<documentation title="Line Length">
|
||||
<standard>
|
||||
<![CDATA[
|
||||
It is recommended to keep lines at approximately 85 characters long for better code readability.
|
||||
]]>
|
||||
</standard>
|
||||
</documentation>
|
||||
@@ -0,0 +1,19 @@
|
||||
<documentation title="Function Calls">
|
||||
<standard>
|
||||
<![CDATA[
|
||||
Functions should be called with no spaces between the function name, the opening parenthesis, and the first parameter; and no space between the last parameter, the closing parenthesis, and the semicolon.
|
||||
]]>
|
||||
</standard>
|
||||
<code_comparison>
|
||||
<code title="Valid: spaces between parameters">
|
||||
<![CDATA[
|
||||
$var = foo($bar, $baz, $quux);
|
||||
]]>
|
||||
</code>
|
||||
<code title="Invalid: additional spaces used">
|
||||
<![CDATA[
|
||||
$var = foo<em> </em>(<em> </em>$bar, $baz, $quux<em> </em>)<em> </em>;
|
||||
]]>
|
||||
</code>
|
||||
</code_comparison>
|
||||
</documentation>
|
||||
@@ -0,0 +1,25 @@
|
||||
<documentation title="Default Values in Function Declarations">
|
||||
<standard>
|
||||
<![CDATA[
|
||||
Arguments with default values go at the end of the argument list.
|
||||
]]>
|
||||
</standard>
|
||||
<code_comparison>
|
||||
<code title="Valid: argument with default value at end of declaration">
|
||||
<![CDATA[
|
||||
function connect($dsn, <em>$persistent = false</em>)
|
||||
{
|
||||
...
|
||||
}
|
||||
]]>
|
||||
</code>
|
||||
<code title="Invalid: argument with default value at start of declaration">
|
||||
<![CDATA[
|
||||
function connect(<em>$persistent = false</em>, $dsn)
|
||||
{
|
||||
...
|
||||
}
|
||||
]]>
|
||||
</code>
|
||||
</code_comparison>
|
||||
</documentation>
|
||||
@@ -0,0 +1,23 @@
|
||||
<documentation title="Class Names">
|
||||
<standard>
|
||||
<![CDATA[
|
||||
Classes should be given descriptive names. Avoid using abbreviations where possible. Class names should always begin with an uppercase letter. The PEAR class hierarchy is also reflected in the class name, each level of the hierarchy separated with a single underscore.
|
||||
]]>
|
||||
</standard>
|
||||
<code_comparison>
|
||||
<code title="Examples of valid class names">
|
||||
<![CDATA[
|
||||
Log
|
||||
Net_Finger
|
||||
HTML_Upload_Error
|
||||
]]>
|
||||
</code>
|
||||
<code title="Examples of invalid class names">
|
||||
<![CDATA[
|
||||
log
|
||||
NetFinger
|
||||
HTML-Upload-Error
|
||||
]]>
|
||||
</code>
|
||||
</code_comparison>
|
||||
</documentation>
|
||||
@@ -0,0 +1,23 @@
|
||||
<documentation title="Function and Method Names">
|
||||
<standard>
|
||||
<![CDATA[
|
||||
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.
|
||||
]]>
|
||||
</standard>
|
||||
<code_comparison>
|
||||
<code title="Examples of valid function names">
|
||||
<![CDATA[
|
||||
connect()
|
||||
getData()
|
||||
buildSomeWidget()
|
||||
XML_RPC_serializeData()
|
||||
]]>
|
||||
</code>
|
||||
<code title="Examples of invalid function names">
|
||||
<![CDATA[
|
||||
Connect()
|
||||
get_data()
|
||||
]]>
|
||||
</code>
|
||||
</code_comparison>
|
||||
</documentation>
|
||||
Reference in New Issue
Block a user