From d46d3709a227915f8649bca7f4162ff66a83da41 Mon Sep 17 00:00:00 2001
From: tbrehm <t.brehm@ispconfig.org>
Date: Thu, 10 Jun 2010 10:27:12 -0400
Subject: [PATCH] Updated version number to 3.0.2.2
---
CODING_NOTES.php.txt | 22 +++++++++++++++-------
1 files changed, 15 insertions(+), 7 deletions(-)
diff --git a/CODING_NOTES.php.txt b/CODING_NOTES.php.txt
index 2108956..ca3cf78 100644
--- a/CODING_NOTES.php.txt
+++ b/CODING_NOTES.php.txt
@@ -1,10 +1,18 @@
Some guidelines for web development with php.
-----------------------------------------------------
-Unix Line Breaks Only, NO windows breaks please.
+* Unix Line Breaks Only, NO windows breaks please.
+* Tabs set at 4 spaces either as tabs or spaces.
+* no accidental _<?php space before, within or after a file
+* every php file starts and end with <?php ?> no spaces before or after
+* error_reporting(E_ALL|E_STRICT) , yep php5
+* Magic quotes is gone in php6, get used to it now. config = magic_quotes_gpc() Everything must be quoted
-Tabs set at 4 spaces either as tabs or spaces.
+please mark any section that need review or work on with
+// TODO
+* Add documentation about access levels (public, private, protected).
+* Make function / var names on the following way, first word lower, next word(s) first letter upper like. getFirstResult();
-Pear coding guiidelines
+Pear coding guidelines
//*****************************************************************************
// Commenting style
@@ -35,7 +43,7 @@
// print_r($foo);
-For incline comment use //** and //* eg
+For inline comment use //** and //* eg
//** Decide what do do
switch($decide){
@@ -58,7 +66,7 @@
Do not use the phpdoc on every function, eg
/**
-* Login an user
+* Login a user
* @param string user username
* @param string password of user
*/
@@ -67,7 +75,7 @@
.......
}
<<
-as this function explains its self, the followinf clean code will suffice
+as this function explains its self, the following clean code will suffice
>>
function login($user, $pass){
.......
@@ -76,7 +84,7 @@
If you do need to explain a function then put un the summary syntax eg
/** Pass an array of values where third param is bar
-* $foo['bar'] = 1; // allow an user
+* $foo['bar'] = 1; // allow a user
* $foo['bar'] = 2; // destroy user
* $foo['bar'] = -1; // recreate
*/
--
Gitblit v1.9.1