Changeset 42 for trunk/docs/coding_standards.txt

Timestamp:

Dec 18, 2005 12:16:03 AM (18 years ago)

Author:

scdev

Message:

detabbed all files ;P

File:

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

trunk/docs/coding_standards.txt

@@ -7 +7 @@
 ======================================================================
 
-We're following the PEAR coding standards, with minor modifications. 
+We're following the PEAR coding standards, with minor modifications.
 
 This is essential reading:
@@ -20 +20 @@
 
 Auth_SQL.inc.php        One PHP Class to be included. The filename is the
-                        type of class, underscore, name. Or if in subdirs, 
+                        type of class, underscore, name. Or if in subdirs,
                         this could be /Auth/SQL.inc.php while the class name
                         remains "Auth_SQL"
@@ -29 +29 @@
                         directly in the web root.
 
-script.cli.php          A command-line executable script, possibly executed 
+script.cli.php          A command-line executable script, possibly executed
                         with CRON, usually outputs TEXT, not HTML.
 
@@ -43 +43 @@
 
 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 
+be wrapped <= 80 characters. Exceptions are made in the case where code
 readability is significantly improved with longer lines.
 
@@ -80 +80 @@
         action1;
         break;
-    
+
     case 2:
         action2;
         break;
-    
+
     default:
         defaultaction;
         break;
-    
+
     }
 
@@ -137 +137 @@
 ======================================================================
 
-When functions return boolean values, use 'return false;' or 'return true;' 
+When functions return boolean values, use 'return false;' or 'return true;'
 as opposed to 'return 0;' or 'return 1;' or 'return(-1);'.
 
@@ -149 +149 @@
 
     $something = $blah . funky() . ".\".=" . $blab;
-    
+
 is better than:
-    
+
     $something = $blah.funky().".\".=".$blab;
 
@@ -159 +159 @@
 ======================================================================
 
-Use the single quote marks ' to enclose simple strings whenever possible. 
-Double quote marks " require extra parsing and thus slow things down, but 
-are necessary if entities there must be swapped-out such as variables or 
+Use the single quote marks ' to enclose simple strings whenever possible.
+Double quote marks " require extra parsing and thus slow things down, but
+are necessary if entities there must be swapped-out such as variables or
 control characters.
 
@@ -196 +196 @@
 ======================================================================
 
-Function comments should follow the Javadoc standard, with detailed 
+Function comments should follow the Javadoc standard, with detailed
 function comments and one-line pointers along the way:
 http://java.sun.com/products/jdk/javadoc/writingdoccomments/index.html
- 
+
     <?php
     /**
@@ -215 +215 @@
     {
         $qid = DB::query("SHOW COLUMNS FROM $db_table LIKE '$db_col'",false);
-            
+
         $row = mysql_fetch_row($qid);
         if (preg_match('/^enum|^set/i', $row[1]) && preg_match_all("/'([^']*)'/", $row[1], $match)) {
@@ -283 +283 @@
 ======================================================================
 
-All HTML should be valid XHTML 1.0 verfied with the 
+All HTML should be valid XHTML 1.0 verfied with the
 W3C Markup Validation Service: http://validator.w3.org/
 
@@ -302 +302 @@
     <td nowrap="nowrap">Example</td>
 
-All tags must be properly closed. Tags without a closing part must follow the 
+All tags must be properly closed. Tags without a closing part must follow the
 XHTML convention and end with a space and a slash: