PHP | Estándares de codificación

PHP sigue pocas reglas y mantiene su estilo de codificación. Como hay muchos desarrolladores en todo el mundo, si cada uno de ellos sigue diferentes estilos y estándares de codificación, esto generará una gran confusión y dificultad para que un desarrollador entienda el código de otro desarrollador. Será muy difícil administrar y almacenar el código para futuras referencias. 

Los estándares de codificación entran en juego por todas las razones. 

Razones para mantener los estándares de codificación:

• Las personas que trabajan en diferentes módulos pueden administrar fácilmente el código fuente debido a la familiaridad.
• Actúa como modelo para que otros miembros del equipo entiendan el código para la gestión o los cambios.
• Clarity ahorra mucho tiempo al cometer errores comunes, ya que es fácil de entender.
• Los estándares de codificación o estándares de la industria mejoran la calidad y la consistencia del software.

A continuación se mencionan algunas pautas que se deben seguir para mantener el estándar de codificación PHP. 

• Etiquetas de PHP: se deben usar las etiquetas estándar de PHP, en lugar de las etiquetas abreviadas para delimitar el código PHP.

  Etiquetas completas:

<?PHP
  PHP code
?>                

   Etiquetas cortas:

<?
  PHP code
?>

• Comentarios: Se recomienda encarecidamente el uso del estilo de comentarios estándar de C y C++, es decir, (//) para una sola línea y (/* */) para líneas múltiples, y el uso de comentarios de estilo Python o Perl, es decir, (#), es desanimado.
• Longitud de línea y sangría: es una recomendación estándar no exceder más de 75-85 caracteres por línea de código. No se deben usar tabulaciones para la sangría, sino espacios, ya que es el método de sangría estándar en la mayoría de los lenguajes de programación. Una declaración por línea o líneas divididas para largas múltiples.
• Estructuras de control: el flujo de control o las declaraciones condicionales deben escribirse de tal manera que puedan diferenciarse de las declaraciones de llamada de función. Al escribir if, for, else, foreach, do, while, switch y otras declaraciones de flujo de controles, debe haber un espacio entre la palabra clave y el paréntesis de apertura. Las definiciones de función no tienen ningún espacio entre el nombre de la función y el paréntesis de apertura.
• Llamadas a funciones: no debe haber espacios entre parámetros, coma, último parámetro y punto y coma. Utilice siempre etiquetas PHP completas y evite las etiquetas abreviadas. Además, dé un espacio entre ambos lados del operador ‘=’.

Ejemplo: 

<?php
 
$n = 5;
if ($n > 0){
    echo "Positive";
}
elseif ($n < 0){
    echo "Negative";
}
else{
    echo "Zero";
}
 
?>

Producción: 

Positive

 Ejemplo: 
 

<?php
 
echo testFunc(5, 6);
 
function testFunc($num1, $num2) {
   $val = $num1 + $num2;
   return $val;
}
 
?>

Producción: 
 

11

• Nombrar variables: hay algunas convenciones que se deben seguir para nombrar las variables: 
  • Uso de letras minúsculas para nombrar las variables.
  • Uso de ‘_’ para separar las palabras en una variable.
  • Los nombres de variables estáticas pueden comenzar con la letra ‘s’.
  • Los nombres de variables globales deben comenzar con la letra ‘g’.
  • Uso de letras mayúsculas para definir constantes globales con ‘_’ como separador.
• Alineación de bloques: cada bloque de código y llaves deben estar alineados.
• Funciones cortas: todas las funciones y métodos deben limitarse a una sola página y no deben ser extensos.

Nota : Las reglas anteriores se proporcionan solo para que el código sea fácilmente comprensible y para administrar el código fácilmente. No habrá ningún error específico en caso de violación de las reglas mencionadas anteriormente. Pero es muy recomendable seguir la convención anterior para mejorar la calidad general del código desde la perspectiva del desarrollador.