extern/egroupware
1
0
Fork 1
mirror of https://github.com/EGroupware/egroupware.git synced 2025-01-28 08:49:00 +01:00
Code Issues Packages Projects Releases Wiki Activity

Updated doc

Browse Source
This commit is contained in:
jengo 2001-05-21 02:49:16 +00:00
parent 90eacf1b15
commit c1f7e245d5
1 changed files with 56 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

68
phpgwapi/doc/coding_standard.txt
View File

@ -1,16 +1,22 @@
1) Format your code so that we can read it. Please! 1) Format your code so that we can read it. Please!
2) Use tabs for formating. NOT SPACES. Tabs creates smaller files and editors allow developers to view a tab as however many spaces as they prefer. Spaces do not allow this. 2) Use tabs for formating. NOT SPACES. Tabs creates smaller files and editors allow
3) Use ' instead of " for strings. This is a performance issue, and prevents alot of inconsistant coding styles. developers to view a tab as however many spaces as they prefer. Spaces do not allow this.
4) Comments go on the line ABOVE the code. NOT to the left of the code! 3) Use ' instead of " for strings. This is a performance issue, and prevents alot of inconsistant
5) For each section of code put a section divider with basic explaination of the following code/functions. coding styles.
4) Comments go on the line ABOVE the code. NOT to the right of the code!
5) For each section of code put a section divider with basic explaination of the following
code/functions.
It should look like this: It should look like this:
/****************************************************************************\ /****************************************************************************\
* These functions are used to pick my nose * * These functions are used to pick my nose *
\****************************************************************************/ \****************************************************************************/
6) Do not document every bit of code in comments. PHP is an interpreted language and it will be nasty on performance 6) Do not document every bit of code in comments. PHP is an interpreted language and it will be
nasty on performance
7) Use switch statements where many elseif's are going to be used. Switch is faster and I like it better! 7) Use switch statements where many elseif's are going to be used. Switch is faster and I like it
better!
8) If statement need to follow the following format 8) If statement need to follow the following format
if ($var == 'example') if ($var == 'example')
@ -25,10 +31,19 @@ It should look like this:
Do NOT make if statements like this Do NOT make if statements like this
if ($var == 'example'){ echo 'An example'; } if ($var == 'example'){ echo 'An example'; }
All other styles are not to be used. This is it. Use it or I will personally come and nag you to death. All other styles are not to be used. This is it. Use it or I will personally come and nag you to
death.
9) ALL if statements HAVE to have match { }
Do NOT create if statements like this:
if ($a == b)
dosomething();
or:
if ($a == b) dosomething();
9) class/function format They make the code more difficault to read and follow
10) class/function format
class testing class testing
{ {
function print_to_screen() function print_to_screen()
@ -48,4 +63,33 @@ All other styles are not to be used. This is it. Use it or I will personally com
Notice that when defining a class we break from the norm (putting } on same line as statement) and move the { to the next line. Dont ask me why, but this is what I/we do. Notice that when defining a class we break from the norm (putting } on same line as statement) and move the { to the next line. Dont ask me why, but this is what I/we do.
This is all I have got for now. 11) Arrays must be written in the following way
$array = array(
'var' => 'value',
'var2' => 'value2'
);
Spaces are permitied between the => 's
12) Use the long format for <?php do NOT use <?
13) All code should start with 1 tab example:
<?php
dosomething();
if ($a)
{
dosomemorestuff();
}
NOT
<?php
dosomething();
if ($a)
{
dosomemorestuff();
}
14) Use lower case for variable and function names. No stubly case code