Amigo estos son algunos de los estándares que utilizo con codeigniter:
Encoding: UTF-8
Files
Headers
Databases (utf8_unicode_ci)
Text Files (js, php, css, etc..)
Line Jumps Unix Style (\n)
Indentation with Tabs (configurable at each IDE)
Shorts tags
INCORRECT:
<?= $var ?>
CORRECT:
<?php echo $var; ?>
PHP closing tag
End of file never include “?>”
Variable Names
Lower case separate by an underscore
INCORRECT:
$j = 'foo';
$String
$bufferedText
$groupid
$name_of_last_city_used // too long
CORRECT:
$buffer
$group_id
$last_city
Databases
Uppercase for MySQL reserved words. Ex. SELECT FROM WHERE
Lowercase for field names using a 3 letter prefix followed by underscore ( _ ). Ex. usr_name
Plural for table names, singular for field names
Use id prefix for foreign keys only. Ex. usr_id_address
Use INNODB
Comments
Use double slash (//) for single comments
Use slash plus double asterisk (/**) just for documentation (phpDocs)
Closing Comments for control structures
Use inline comment for control structure closing brace when there’s long chunck of code between, and always in view files.
INCORRECT:
if( $foo == FALSE)
{
foreach($collection AS $item)
{
/**
*
* Big Chunk of code
*
*
*
*
*/
}
}
<?php if ($this) { ?>
<h1>On Templates</h1>
<?php } ?>
CORRECT:
if( $foo == FALSE) {
foreach($collection AS $item) {
/**
*
* Big Chunk of code
*
*
*
*
*/
} // end foreach
} // end if
<?php if ($this) { ?>
<h1>On Templates</h1>
<?php } // end if ?>
Functions / Methods
Use camelCase
INCORRECT:
newclient
Newclient
NewClient
new_client
CORRECT:
newClient
Class Names
Uppercase first letter and use underscore ( _ ) bettwen words.
INCORRECT:
paidclient
Paid_client
paidClient
CORRECT:
Paid_Client
Error validation
Validate known failure conditionals first.
EXAMPLE
function foo(string $bar)
{
if(‘’ == $bar)
{
continue; // failure condition not met
}
// code when validation has been passed
}
Constants
Upercase always, only as long as necesary for be descriptive, no single letters. Use underscore ( _ ) between words.
INCORRECT:
myConstant
N // no single-letter constants
S_C_VER // not descriptive
constants
CORRECT:
MY_CONSTANT
NEWLINE
SUPER_CLASS_VERSION
FALSE, TRUE and NULL
Upercase always.
Logical Operators
Always use && for “AND” and || for “OR”
Spacing
Always use spaces when using operators or concatenation.
INCORRECT:
if($str, 'foo')==FALSE)
$welcome_message=”Welcome ”.$name.”!”;
$sum=1+2;
for($j=0;$j<10;$j++)
CORRECT:
if ($str, 'foo') == FALSE)
$welcome_message = ”Welcome ” . $name . ”!”;
$sum = 1 + 2;
for ($j = 0; $j < 10; $j++)
Comparing Return Values and Typecasting
Always compare with “===” to check the type of var.
INCORRECT:
if (strpos($str, 'foo') == FALSE)
CORRECT:
if (FALSE === strpos($str, 'foo'))
Conditionals
Always use open and close brackets, even in one line conditions
INCORRECT:
if (FALSE === strpos($str, 'foo'));
//Do some stuff
CORRECT:
if (FALSE === strpos($str, 'foo'))
{
//Do some stuff
}
Ternary Conditionals
Use them where possible to clarify.
INCORRECT:
$x = $parameter;
if( empty($parameter) )
{
$x = ‘default’;
}
if ( $is_correct )
{
doSomeStuff();
}
$value == ‘something’ && doThatStuff(); //To many operators
CORRECT:
$x = (empty($parameter)) ? ’default’ : $parameter;
$is_correct && doSomeStuff();
Code Indentation and opening braces
Use of line break mefore opening brace both for functions / methods and control structures.
INCORRECT:
function foo($bar) {
// ...
}
foreach ($arr as $key => $val) {
// ...
}
CORRECT:
function foo($bar)
{
// ...
}
foreach ($arr as $key => $val)
{
// ...
}
Strings
Use single quotes, double quotes used only when scaping variables and SQL queries. Scaped variables always between curly braces ( {$variable} ).
INCORRECT:
"My String"
"My string $foo"
'SELECT foo FROM bar WHERE baz = \'bag\''
CORRECT:
'My simple String'
"My escaping string {$foo}"
"SELECT foo FROM bar WHERE foo = {$foo} AND bar = 'bar'"
Documentation
Following phoDoc standards, use always at Class and Function level, otherwise only if necessary.
/**
* Use phpDoc Sintax
*/
At the top of the file we have to describe the goal for the current file, the date when it was created and the author.
/**
* Use class description, use author tag for class developer,
* todo tag when not completed or for future implementations and other tags as needed
*
* @author Developer Name <
username@domain.tld>
* @todo Something that cannot be implemented at the moment.
*/
For each function we must document it following the same structure with the following data:
/**
* Use function description followed by author tag, acces level,
* params if any, return
*
* @author Developer Name <
username@domain.tld>
* @todo Something that cannot be implemented at the moment.
* @access private
* @param bool $baz
* @return string the name of something
*/
// TODO use inline todo’s when for future refactoring
// FIXME use fixme when patching code
Saludos, espero te sirvan
Eduardo R. Hernández Arenas
PHP 5 POO y MySQL Developer 5
Mensajes recientes
y así no hacer tanto scroll en el foro.