PHP - Estándar de codificación

Cada empresa sigue un estándar de codificación diferente según sus mejores prácticas. Se requiere un estándar de codificación porque puede haber muchos desarrolladores trabajando en diferentes módulos, por lo que si comienzan a inventar sus propios estándares, la fuente se volverá muy inmanejable y será difícil mantener ese código fuente en el futuro.

Aquí hay varias razones por las que utilizar especificaciones de codificación:

Sus programadores pares deben comprender el código que produce. Un estándar de codificación actúa como modelo para que todo el equipo descifre el código.
La simplicidad y la claridad logradas mediante una codificación constante le ahorran errores comunes.
Si revisa su código después de un tiempo, será fácil de entender ese código.
Su estándar de la industria es seguir un estándar particular para tener más calidad en el software.

Hay algunas pautas que se pueden seguir al codificar en PHP.

Indenting and Line Length- Use una sangría de 4 espacios y no use ninguna pestaña porque diferentes computadoras usan diferentes configuraciones para la pestaña. Se recomienda mantener las líneas de aproximadamente 75 a 85 caracteres para una mejor legibilidad del código.
Control Structures- Estos incluyen if, for, while, switch, etc. Las sentencias de control deben tener un espacio entre la palabra clave de control y el paréntesis de apertura, para distinguirlas de las llamadas a funciones. Se le recomienda encarecidamente que utilice siempre llaves incluso en situaciones en las que sean técnicamente opcionales.

Examples

if ((condition1) || (condition2)) {
   action1;
}elseif ((condition3) && (condition4)) {
   action2;
}else {
   default action;
}

Puede escribir declaraciones de cambio de la siguiente manera:

switch (condition) {
   case 1:
      action1;
      break;
   
   case 2:
      action2;
      break;
         
   default:
      defaultaction;
      break;
}

Function Calls- Las funciones deben llamarse sin espacios entre el nombre de la función, el paréntesis de apertura y el primer parámetro; espacios entre comas y cada parámetro, y ningún espacio entre el último parámetro, el paréntesis de cierre y el punto y coma. He aquí un ejemplo:

$var = foo($bar, $baz, $quux);

Function Definitions - Las declaraciones de funciones siguen el "estilo BSD / Allman" -

function fooFunction($arg1, $arg2 = '') {
   if (condition) {
      statement;
   }
   return $val;
}

Comments- Los comentarios de estilo C (/ * * /) y los comentarios estándar de C ++ (//) están bien. Se desaconseja el uso de comentarios de estilo Perl / shell (#).
PHP Code Tags- Utilice siempre <? Php?> Para delimitar el código PHP, no <? ?> taquigrafía. Esto es necesario para el cumplimiento de PHP y también es la forma más portátil de incluir código PHP en diferentes sistemas operativos y configuraciones.
Variable Names -
- Utilice todas las letras minúsculas
- Utilice '_' como separador de palabras.
- Las variables globales deben ir precedidas de una 'g'.
- Las constantes globales deben estar en mayúsculas con separadores '_'.
- Las variables estáticas pueden ir precedidas de 's'.
Make Functions Reentrant - Las funciones no deben mantener variables estáticas que impidan que una función sea reentrante.
Alignment of Declaration Blocks - Se debe alinear el bloque de declaraciones.
One Statement Per Line - Debe haber solo una declaración por línea a menos que las declaraciones estén muy relacionadas.
Short Methods or Functions - Los métodos deben limitarse a una sola página de código.

Podría haber muchos más puntos que deberían tenerse en cuenta al escribir su programa PHP. En general, la intención debe ser ser coherente en toda la programación del código y solo será posible cuando siga algún estándar de codificación. Puede diseñar su propio estándar si le gusta algo diferente.

↰ Previous page Next page ↱