PHP: Linter
En esta lección aprenderemos qué son los estándares de codificación. Facilitan el desarrollo y hacen que el código sea más comprensible. Vamos a analizar en detalle dos recomendaciones principales para PHP que contienen reglas de codificación.
Estándares de codificación en PHP
El código debe estar formateado de manera que sea comprensible y fácil de mantener. Para ello existen conjuntos de reglas especiales llamados estándares. Estos describen varios aspectos de la escritura de código.
En PHP, los estándares más comunes son los PSR - PHP Standards Recommendations o Recomendaciones de Estándares PHP de PHP-FIG. Son un conjunto de reglas que facilitan el desarrollo y resuelven problemas específicos.
Actualmente existen varias recomendaciones aprobadas, cada una de ellas se identifica con un número: PSR-1, PSR-2, PSR-3 y otros. Conocerás todas estas recomendaciones durante el aprendizaje y el trabajo. En esta lección, vamos a analizar en detalle las siguientes:
- PSR-1. Basic Coding Standard - estándar básico de codificación. Es un conjunto de reglas que definen cómo formatear el código: cómo escribir etiquetas PHP, cómo nombrar clases, métodos y constantes de clases. También aborda cuestiones de codificación, autoloading, namespaces y separación de responsabilidades entre archivos.
- PSR-12. Extended Coding Style - estándar de estilo de codificación extendido, reemplaza y amplía el obsoleto PSR-2. Este estándar requiere el cumplimiento de las reglas de PSR-1. También agrega muchas nuevas reglas: sangrías, archivos, líneas, palabras clave, clases, estructuras de control, ámbitos y otros elementos.
Linters en PHP
En cualquier lenguaje de programación existen herramientas especiales llamadas linters. Verifican el código en busca de cumplimiento de los estándares. El linter ampliamente utilizado en PHP es PHP_CodeSniffer.
Supongamos que tenemos un archivo con el siguiente código PHP:
<?php
// La siguiente línea tiene una sangría de una tabulación
print_r (((8 / 2) + 5) - (-3 / 2));
?>
Al verificar el archivo, el linter encontrará los siguientes errores:
Spaces must be used to indent lines; tabs are not allowed- PSR-12 recomienda usar una sangría de cuatro espacios, pero en el ejemplo se utiliza una tabulación.A closing tag is not permitted at the end of a PHP file- el estándar requiere omitir la etiqueta de cierre?>.Space before opening parenthesis of function call prohibited- al llamar a una función, no debe haber espacios entre el nombre de la función y los paréntesis. Sin embargo, en el código verificado hay un espacio después del nombreprint_r.
Vamos a corregir el código: eliminaremos la etiqueta de cierre, las sangrías y el espacio después del nombre de la función:
<?php
print_r(((8 / 2) + 5) - (-3 / 2)); // => 10.5
Esta versión ya cumple con las reglas y el linter no mostrará ningún mensaje de error.
Tarea
Muestra en pantalla el resultado de la siguiente operación: "la diferencia entre el cuadrado de cinco y el producto de tres y siete". Escribe el código de manera que cada operador esté separado de los operandos por espacios.
¿El ejercicio no pasa la prueba, qué debo hacer? 😶
Si te quedaste atascado, es el momento perfecto para hacer una pregunta en las "Discusiones".
* Asegúrate de incluir la salida de las pruebas. Sin ella, es casi imposible entender qué está mal, incluso si muestras tu código. Los programadores tienen dificultades para ejecutar el código en su mente, pero casi siempre es posible entender a dónde mirar a partir del error que recibiste.
Mi código funciona en mi entorno, pero no aquí 🤨
Las pruebas están diseñadas de manera que verifican la solución de diferentes maneras y con diferentes datos. A menudo, una solución funciona con ciertos datos de entrada pero no con otros. Para entender este punto, revisa la pestaña "Pruebas" y presta atención a los mensajes de error, que suelen contener pistas.
Mi código es diferente a la solución del profesor 🤔
Esto es normal 🙆. En programación, una tarea puede tener muchas soluciones diferentes. Si tu código pasa la prueba, cumple con los requisitos de la tarea.
En raras ocasiones, la solución puede estar ajustada para pasar las pruebas, pero esto suele ser evidente.
Leí la lección, pero no entendí nada 🙄
Crear materiales de aprendizaje comprensibles para todos es bastante difícil. Hacemos nuestro mejor esfuerzo, pero siempre hay margen para mejorar. Si encuentras material que no entiendes, describe el problema en las "Discusiones". Es ideal si puedes formular los aspectos que no entiendes en forma de preguntas. Por lo general, necesitamos unos días para hacer mejoras.
Por cierto, tú también puedes contribuir a mejorar los cursos: en la parte inferior hay un enlace al código fuente de las lecciones, que se puede modificar directamente en el navegador.