tbrehm
2010-05-27 f7d92d1ba673c88620c783547f9c88cb2406a7e4
CODING_NOTES.php.txt
@@ -7,10 +7,12 @@
* 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
please mark any section that nned review or work on with
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
@@ -41,7 +43,7 @@
// print_r($foo);
For incline comment use //** and //* eg
For inline comment use //** and //* eg
//** Decide what do do
switch($decide){
@@ -64,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
*/
@@ -73,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){
.......
@@ -82,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
*/