Viewing file:  convenciones.php (4.93 KB) -rw-r--r--
Select action/file-type:
 (+) |  (+) |  (+) | Code (+) | Session (+) |  (+) | SDB (+) |  (+) |  (+) |  (+) |  (+) |  (+) |
<?php
/**
* Recomendaciones Generales:
* - Usar tabs en lugar de espacios cuando se entran a nuevos scopes.
* - Los nombres de archivos, clases, atributos, métodos, etc. son
* en minúsculas y separados por guiones bajos. Ej. objeto_ei_formulario
*/
require_once('nucleo/archivo.php'); //Sección de includes. Usar paths relativos a mi_proyecto/php
/**
* Lugar de explicación general de la clase (en formato javadoc)
*
* Tratar de respetar (cant_clases($archivo) == 1), salvo que sean clases muy chicas o muy cohesivas
* Tratar de respetar ($nombre_archivo == $nombre_clase . '.php');
*
* @package Paquete al que pertenece la clase (Objetos, Librerias, Nucleo, Recursos, Varios, etc.)
* @subpackage Subpaquete (Persistencia, Ei, Navegación, Negocio, etc.)
* @todo Cosas pendientes por hacer, si es groso tratar de relacionarlo con algún ticket
*/
class convenciones extends clase_padre
{
/**
* Tratar de que los atributos sea protegidos
* Cuando sea posible, brindar valores por defecto en lugar de inicializarlos en el constructor
* No es necesario usar phpdoc a este nivel (ocupa mucho espacio y en general acceder a las propiedades es algo de bajo nivel
*/
protected $atributo1 = 'valor'; //Tratar de que los comentarios de los atributos
protected $atributo2; //queden alineados
/**
* Usar el constructor de php5
*/
function __construct()
{
}
/**
* Ingresar descripción phpdoc del método
* Solo explicitar el tipo de acceso (protected, private) cuando no es publico
* Un buen signo de documentación de un método es si su nombre ya documenta su uso
*
* @param array $nombre_significativo Descripción del parámetro
* @param boolean $incluir_todo Todos los parámetros se documentan
* @return boolean Descripción del retorno
*/
protected function prototipo_de_metodo($nombre_significativo, $incluir_todo=true)
{
}
/**
* Usar @deprecated para marcar los métodos a los que se le quitará soporte en próximas versiones
* @deprecated Desde version x.y.z
*/
function no_me_llames()
{
toba::logger()->obsoleto(__CLASS__, __FUNCTION__, 'Explicar qué cosa usar');
}
//------------------------------------------------------------------------
//------ SINTAXIS (esta es una sección!) (crear una macro!)---------------
//------------------------------------------------------------------------
function espacios()
{
//Asignación:
$algo = $otra_cosa; //Espacio antes y despues del igual para separar bien las aguas
//Una asignación por línea
//Asignaciones seguidas
$persona = array(); //Usar identación con tabs cuando haya dos o más asignaciones seguidas. Estoy ayuda a la legibilidad.
$persona['nombre'] = 'Roberto';
$persona['edad'] = 12;
$persona['sexo'] = 'M';
//Espacio despues de if, for, while, etc.,
if ($tal_cosa) {
//Para llamar a un método:
$objeto->metodo($par1, $par2); //Los parametros se separan por comas.. y despues de cada coma un espacio!
}
//Expresiones
$a = $b + $c; //Espacio entre operadores
$a = $b && $c; //Usar && y || en lugar de AND y OR (php hereda de C)
//Arreglos
$a = $b[$indice]; //El acceso es sin espacios
}
function variables()
{
/**
* Nomenclatura de variables:
* - Usar $i,$j o cosas así para contadores
* - En general, evitar usar $temp, $pepe, $x o cosas por el estilo!
* - Llamar 'Las cosas por su nombre' :P
*/
//Porqué inicializar los arreglos???
$arreglo = array();
if ($condicion_que_casi_siempre_se_da) {
$arreglo[] = 'valor';
}
return $arreglo; //Para que el consumo de lo que se retorna sea uniforme
} //por ejemplo si alguien quiere hacer un foreach con el resultado
/**
* Los bloques de clases y metodos tienen llaves {} en líneas propias (son solo contenedores)
*/
function bloques()
{
//En cambio el resto de las estructuras de control abren su llave en la misma línea
//La idea es aumentar la cantidad de cosas concretas por linea y no usar dos lineas que solo contienen delimitadores)
if ($condicion) {
foreach ($elemento as $id) {
echo $id;
}
} else {
echo 'Otra cosa';
}
}
function strings()
{
//Usar comillas simples cuando el contenido es estatico
$simples = 'contenido';
//Usar comillas dobles sólo cuando dentro hay una variable/llamada
$dobles = "$simples dinámico";
//Aprovechar los strings multilínea
//Comparar la legibilidad, flexibilidad a cambios,
//facilidad de traer o llevar a un editor de sql y agilidad de escribir ESTO:
$sql = " SELECT
campo1 as mi_campo,
campo2
FROM
tabla1 t1,
tabl2 t2
WHERE
t1.condicion = t2.condicion
AND t1.nombre = $variable
"; //Cerrar el string aca facilita agregar algo al final del sql sin preocuparse por las comillas
//Con ESTO otro:
$sql = ' SELECT'.
' campo1 as mi_campo,'.
' campo2'.
' FROM'.
' tabla1 t1,'.
' tabl2 t2'.
' WHERE'.
' t1.condicion = t2.condicion';
}
}
?>
|