Share
En este sitio, pasamos mucho tiempo compartiendo información y discutiendo cómo lograr ciertas cosas con WordPress. Después de todo, el propósito del sitio. es para proporcionar tutoriales, es decir, intentamos dar consejos prácticos sobre cómo construir ciertas cosas utilizando la plataforma.
Pero el desarrollo no es estrictamente sobre escribir código y construir cosas. También se trata de calidad de escritura, código mantenible, refactorización y mejora del estado de nuestros proyectos y, en general, tratar de dejar un código base en un estado mejor que cuando lo encontramos (o cuando empezamos a crearlo).
Entonces, en lugar de centrarnos en cómo construir algo o revisar cualquier código en particular, repasemos algunos consejos prácticos para escribir código de WordPress de calidad.
En primer lugar, y aunque lo discutamos mucho, vale la pena repetirlo una y otra vez:
Seguir los estándares de codificación de WordPress es una de las cosas más importantes que puede hacer al escribir sus temas, complementos o aplicaciones..
Para aquellos que no están familiarizados, los Estándares de codificación de WordPress proporcionan reglas sobre cómo debemos formatear nuestro PHP basado en WordPress. Por supuesto, no hay nada que hacer. hacer cumplir Las reglas: puede ignorarlas (y muchas lo hacen), pero se considera una buena práctica para aquellos que toman en serio el desarrollo de proyectos basados en WordPress, y es respetada por aquellos que son activos en la comunidad..
Además, seguir los estándares de codificación significa que nosotros, junto con todos los demás desarrolladores que también lo hacen, tendremos un código de aspecto similar. De hecho, uno de los objetivos de los estándares de codificación definidos es que el código parezca haber sido escrito por un solo desarrollador..
Otra ventaja de hacer esto es que también facilita que otros contribuyan a nuestro código base. Después de todo, dado que WordPress y sus trabajos derivados son de código abierto, es posible que otros quieran venir y desembolsar o contribuir, en última instancia, dándoles la capacidad de leer fácilmente nuestro código..
Por último, esto no es necesariamente un llamado a la acción para volver y refactorizar todo lo que has hecho. Ahora es un buen momento para comenzar a seguir los estándares. Los buenos desarrolladores están mejorando todo el tiempo, por lo que es totalmente aceptable comenzar ahora (incluso si está en medio de un proyecto).
Una de las cosas más útiles que puede hacer al escribir código es dejar comentarios útiles que expliquen exactamente qué es lo que está intentando hacer..
Naturalmente, los comentarios pueden vivir en el nivel de clase, nivel de función y nivel de línea. Están permitidos en PHP, HTML, JavaScript y CSS, por lo que realmente no hay excusa. no para incluirlos en algún lugar.
Claro, escribir comentarios toma un poco más de tiempo, pero recuerda que si fuera fácil de leer, no se llamaría código.
Piénselo de esta manera: los programadores son conocidos por regresar a sus proyectos anteriores y reconocer lo malo que es su código, o cómo haríamos algo diferente si estuviéramos trabajando en ese proyecto ahora..
Si decimos eso sobre nuestro propio código, ¿qué deben pensar los demás cuando ven nuestro código, especialmente si vienen de un fondo más experimentado??
Para obtener información más detallada sobre cómo comentar tanto el código del servidor como el del cliente, asegúrese de revisar esta serie..
Otra cosa que los desarrolladores podemos hacer es simplificar nuestras funciones. Aunque me doy cuenta de que esto es un área subjetiva, creo que apuntar a funciones más pequeñas y enfocadas hace que el código sea más legible y, en última instancia, puede ayudar con la capacidad de prueba (si está interesado en ir por ese camino).
Primero, no es raro ver funciones que superen las 30, 40 o 50 líneas. El problema es que estas funciones suelen hacer más de una cosa..
Esto es problemático porque:
Entonces, dicho esto, hay algunos consejos prácticos que podemos seguir para mejorar la calidad de nuestras funciones..
Si se encuentra escribiendo lo mismo una y otra vez entre diferentes funciones, entonces ese es un caso para cuando necesite extraer esa parte particular del código y moverla a su propia función para que todos los lugares a los que pueda acceder puedan acceder a ella. actualmente existe.
Si encuentra que su código es complicado de describir con comentarios o difícil de rastrear mientras lo lee, entonces puede valer la pena dar un paso atrás y refactorizar su código en algo un poco más simple..
Esto se ve diferente en cada situación, pero esforzarse por lograr la legibilidad sobre la complejidad es a menudo un objetivo mejor para esforzarse en lugar de simplemente hacer que algo funcione..
Podría decirse que este es el punto más subjetivo, creo que vale la pena mencionarlo y es simplemente que deberíamos esforzarnos por mantener nuestras funciones pequeñas con 20 líneas, siendo una longitud relativamente sólida a la que apuntar. Claro, esto puede ser un tanto desafiante con la forma en que WordPress a menudo nos obliga a crear matrices grandes para que pasemos como argumentos, pero entiendes la idea: mantenlos pequeños, enfocados y mantenibles.
Sí, esto resultará en más funciones, pero el código será más fácil de leer y mantener, ya que cada función tiene un único propósito específico. Esto significa que puede nombrarlos con mayor claridad y proporcionar pruebas unitarias alrededor de ellos más fácilmente.
Obviamente, ninguna de las anteriores son reglas difíciles que deben seguirse, son simplemente sugerencias sobre cómo mejorar la calidad del código que escribimos, mantenemos y contribuimos al trabajo de otros..
Por encima de lo demás, creo que deberíamos esforzarnos por la legibilidad y la capacidad de prueba. Mantener esos dos objetivos en la vanguardia de nuestro trabajo ayudará a que todo lo demás llegue a su lugar adecuado.
Por supuesto, esto no es una lista completa, ¡está lejos de serlo! Así que por favor ofrezca sus sugerencias en los comentarios.!
Accentsconagua