Los estándares de codificación de WordPress sangría, uso del espacio y espacios finales

El propósito de esta serie es ayudar a exponer los estándares de codificación de WordPress, por qué son importantes y cómo escribir código de WordPress de calidad. Para hacer esto, analizamos cada sección de los estándares de codificación de WordPress..

Hasta ahora, hemos cubierto:

  • Convenciones de nomenclatura y argumentos de función
  • Cotizaciones individuales y cotizaciones dobles

Hoy vamos a cubrir la importancia del espacio en blanco. Específicamente, vamos a cubrir la sangría, el uso del espacio y los espacios finales. Tan fácil como suena, estos son algunos de los aspectos más ignorados o mal utilizados de los estándares de codificación..


Una palabra sobre el espacio en blanco

Antes de ver lo que sucede con los distintos estándares de codificación, es importante comprender por qué el espacio en blanco es importante no solo en WordPress, sino en los lenguajes de programación en general..

En pocas palabras, es porque mejora la legibilidad.

Esta es la razón por la que algunos lenguajes de programación son espacios o delimitados por tabuladores, es por eso que algunos lenguajes de programación le piden que se espacien ciertas partes del código, como los parámetros de función, los índices de matriz, y más.

Cuando se trata de WordPress, las convenciones se aplican no solo para facilitar la lectura, sino también para proporcionar una experiencia de lectura y desarrollo coherente para todos los que trabajan en temas, complementos, aplicaciones o la aplicación central de WordPress..

Recuerda: El propósito de los estándares de codificación es hacer que el código fuente parezca escrito por un solo desarrollador, ya que establece un nivel de expectativas para los desarrolladores contribuyentes..


Sangría

En lo que respecta a la sangría, no hay nada particularmente nuevo, revolucionario o diferente en lo que se refiere a WordPress. En general, cada vez que comiences un nuevo bloque, harás sangría.

Esto significa que:

  • Tus funciones serán sangradas dentro de la clase.
  • Sus condicionales y cambio / casos y otros bloques serán sangrados dentro de sus funciones
  • Sus bucles serán sangrados dentro de sus funciones, dentro de sus condicionales, etc.

Si estás acostumbrado a escribir código en lenguajes de estilo C, entonces no hay nada particularmente nuevo aquí, a la derecha?

Un ejemplo de cómo puede verse esto es exactamente esto:

 función foo ($ argumentos) si (0 < count( $arguments )  foreach ( $arguments as $arg => $ valor) echo $ valor; 

Según las Normas de Codificación:

Su sangría siempre debe reflejar la estructura lógica. Utilizar pestañas reales y no espacios, Como esto permite la mayor flexibilidad entre los clientes..

La clave es que el comienzo de las líneas debe comenzar con pestañas, y que el código debe reflejar una lógico estructura. No exageres ni trates de simplificar demasiado las cosas..

Hay otro matiz en el espacio en blanco dentro de los Estándares de Codificación de WordPress: las pestañas deben usarse al principio de la línea, pero los espacios deben usarse en cualquier otro lugar. En su mayor parte, esta es una regla fácil de seguir; Sin embargo, en WordPress, a menudo vas a crear matrices para pasar como argumentos..

Idealmente, queremos que cada índice de la matriz se alinee de modo que la legibilidad sea lo más alta posible, pero a menudo tenemos la propensión a usar pestañas para facilitar la alineación, pero esto es en realidad una violación de los estándares de codificación..

 $ args = array ('ID' => 1, 'post_title' => 'The Title', 'post_content' => 'The content');

Como tal, asegúrese de que usted solamente Usa pestañas al principio de cada línea..


Uso del espacio

En lo que se refiere a WordPress, he encontrado que los espacios se han utilizado de manera mucho más generosa que en otros idiomas. No estoy diciendo esto simplemente como una observación, ya que era un ajuste personal que necesitaba hacer tanto de .NET como de Ruby..

Dicho esto, como ocurre con la mayoría de las otras directrices en el Codex, no hay nada que sea particularmente complejo; sin embargo, hay algunas distinciones importantes que deben recordarse al escribir el código.

Los espacios deben colocarse en los siguientes lugares:

  • Despues comas
  • A ambos lados de los operadores lógicos (es decir,, ||, &&, y !)
  • En ambos lados de los operadores de comparación (es decir,, <, >, ==, ===, etc.)
  • A ambos lados de los operadores de asignación (a saber, =)
  • En ambos lados del paréntesis de apertura y cierre de funciones, condicionales, bucles, etc..
  • Cuando una variable se pasa como un índice de una matriz, pero no cuando un valor literal (como una cadena o un entero)

La mayoría de estos son relativamente sencillos, pero en mi experiencia he encontrado que las reglas de la matriz tienden a causar la mayor confusión entre los desarrolladores, así que aquí hay una breve nota de lo que se considera correcto y lo que no:

 // Espaciado correcto ... $ arr [$ x] = 'foo'; $ arr [0] = 'bar'; // Espaciado incorrecto ... $ arr [$ x] = 'barra'; $ arr [0] = 'bar';

Como puede ver, no es nada terriblemente complicado, pero es una convención relativamente fácil de perder..


Espacios finales

Esta regla es probablemente el estándar más fácil de recordar de todos ellos. En pocas palabras, no debe haber espacios al final de cualquier línea de código.

Dependiendo de su IDE, puede tener este filtro incorporado; otras veces, es posible que deba instalar un complemento que realizará esta acción por usted cada vez que guarde el archivo. Pero en cualquier caso, es una función relativamente fácil de integrar en cualquier IDE que estés usando.

Además, la mayoría de los editores, independientemente de si es un editor de texto glorificado o un IDE completo, debe tener la capacidad de habilitar la visualización de tabulaciones y espacios.

Visualización de pestañas y espacios en blanco en Coda 2

Una vez más, esta es una de las convenciones más sencillas de seguir y es probable que su IDE o editor de elección tenga esta característica o un complemento disponible que le permita hacerlo automáticamente..

De lo contrario, debería poder activar la capacidad de ver pestañas, espacios, retornos de carro, etc. para que pueda identificarlos fácilmente. dónde los espacios finales son.


Conclusión

Obviamente, el espacio en blanco coloca un papel importante en la escritura de código basado en WordPress. En este artículo, hemos explorado la sangría, las pestañas, los espacios, los espacios finales y por qué y cómo incorporarlos en nuestros proyectos..

En el siguiente artículo, continuaremos hablando sobre las sutilezas de los Estándares de codificación de WordPress al observar el estilo de corsé, las expresiones regulares y los matices del uso de etiquetas PHP a través de nuestro código de WordPress..