Changeset 293 for trunk/docs

Timestamp:

Dec 11, 2007 10:53:46 PM (16 years ago)

Author:

quinn

Message:

Minor updates.

File:

• trunk/docs/coding_standards.txt (modified) (12 diffs)

trunk/docs/coding_standards.txt

@@ -14 +14 @@
 
 ======================================================================
-File naming conventions
+File Naming Conventions
 ======================================================================
 
@@ -32 +32 @@
                         with CRON. Outputs TEXT if any instead of HTML.
 
+script.inc.eml          Text file to be sent by email.
+
 schema.mysql            Database schema file that goes with the application.
 
@@ -39 +41 @@
 
 ======================================================================
-Indenting and wrap
+Indenting and Wrap
 ======================================================================
 
 Use an indent of 4 spaces, with no tabs. Code and especially comments should
-be wrapped <= 80 characters. Exceptions are made in the case where code
-readability is significantly improved with longer lines.
+usually be wrapped <= 80 characters. Exceptions are made in the case where 
+code readability is significantly improved with longer lines.
 
 
@@ -113 +115 @@
 
 ======================================================================
-Function Definitions
+Function and Method Definitions
 ======================================================================
 
@@ -129 +131 @@
 attempt to return a meaningful value from a function if one is appropriate.
 
-Recommend using studlyCaps for function names, to distinguish from php
-internal functions which standard on under_score_space() style names.
-
-
-======================================================================
-Return values
+Use lowerCamelCase for function and method names to distinguish from php
+internal functions which standard on underscore_space_style_names().
+
+
+======================================================================
+Return Values
 ======================================================================
 
 When functions return boolean values, use 'return false;' or 'return true;'
-as opposed to 'return 0;' or 'return 1;' or 'return(-1);'.
-
-
-======================================================================
-String concatenation
+as opposed to 'return 0;' or 'return 1;' or 'return(-1);', except when
+boolean plurality is necessary.
+
+
+======================================================================
+String Concatenation
 ======================================================================
 
@@ -156 +159 @@
 
 ======================================================================
-Quote marks
+Quote Marks
 ======================================================================
 
@@ -164 +167 @@
 control characters.
 
-        $var['singlequote'] = 'singlequote';
-        $var["doublequote-$i"] = "$vars and \n funny \t %s things need doublequotes";
-        $var['doublequote-' . $i] = $var . 'you can do this' . "\t %s" . $var2 .
-        'but it isn\'t any better';
-
-
-======================================================================
-Printing html
+    $var['singlequote'] = 'singlequote';
+    $var["doublequote-$i"] = "$vars and \n funny \t %s things need doublequotes";
+    $var['doublequote-' . $i] = $var . 'you can do this' . "\t %s" . $var2 .
+    'but it isn\'t any better';
+
+
+======================================================================
+Printing HTML
 ======================================================================
 
@@ -179 +182 @@
 
     <?php
-    if (something) {
-        // Here comes the HTML...
+    if ($something) {
+        // Here comes multi-line HTML...
         ?>
         <div class="sc-tiny">
@@ -186 +189 @@
         </div>
         <?php
-    } else if (somethingelse) {
-        ?><h1>Just a little html</h1><?php
+    } else if ($somethingelse) {
+        ?><h1>Just a single-line of html</h1><?php
     }
     ?>
@@ -271 +274 @@
 ======================================================================
 
-ALWAYS use <?php ?> to delimit PHP code, not the <?php ?> shorthand. Even
-use <?php echo $name ?> instead of <?php echo $name; ?>.
-
-
-======================================================================
-php.ini settings
+Always use <?php ?> to delimit PHP code, not the <? ?> shorthand. Even
+use <?php echo $name; ?> instead of <?=$name?>.
+
+
+======================================================================
+php.ini Settings
 ======================================================================
 
 All code should work with register_globals = Off. This means using
-$_GET, $_POST, $_COOKIE, $_SESSION,
-$_SERVER, and $_ENV to access all get, post, cookie,
-session, server, and environment data, respectively.
+$_REQUEST, $_GET, $_POST, $_COOKIE, $_SESSION, $_SERVER, and $_ENV
+to access all request, get, post, cookie, session, server, and 
+environment data, respectively.
 
 All code should work with error_reporting = E_ALL. Failure to do so would
@@ -289 +292 @@
 
 All code should work regardless of the setting of magic_quotes_gpc.
-Form data should be passed through stripslashes if necessary.
+Form data should be passed through stripslashes() if necessary.
 
 No code should assume that '.' is in the include path. Always
 specify './' in front of a filename when you are including a file in
-the same directory.
+the same directory. Or better yet, for less abiguity, use:
+include dirname(__FILE__) . '/include_me.inc.php';
 
 
@@ -300 +304 @@
 ======================================================================
 
-All HTML should be valid XHTML 1.0 verfied with the
+All HTML should be valid XHTML 1.0 verified with the
 W3C Markup Validation Service: http://validator.w3.org/