Comprender la importancia de las normas de codificación

Las normas de codificación son como las reglas gramaticales de la programación. Al igual que una gramática adecuada hace que el lenguaje escrito sea claro y comprensible, las normas de codificación hacen que su código sea coherente y legible.

• Para usted: You’ll find it easier to read and update your code in the future.
• Para otros: Si comparte su código o trabaja en equipo, los demás apreciarán la claridad.
• Para WordPress: Since it’s open-source, many people contribute. Standards keep everything unified.

Aplicación en el mundo real de las normas de codificación en el trabajo en equipo

Imagine you’re working on a WordPress project as part of a large team. Everyone contributes different parts of the code—some focus on the backend, others on styling, and others on accessibility. Without consistent standards, the project can become chaotic quickly. Coding standards ensure that:

• Colaboración fluida: When everyone follows the same rules, it’s easier for developers to read and understand each other’s work.
• Menos conflictos de fusión: Un formato incoherente suele provocar conflictos de código al fusionar los cambios. Las normas minimizan estos conflictos, lo que permite al equipo trabajar con mayor eficacia.
• Mejor incorporación: Los nuevos desarrolladores que se incorporan al proyecto pueden ponerse al día rápidamente siguiendo un estilo de codificación estandarizado, lo que reduce el tiempo dedicado a comprender el código existente.

Considere un escenario en el que un desarrollador abandona el proyecto y un nuevo miembro del equipo debe hacerse cargo de su parte. Si el desarrollador anterior siguió las normas de codificación adecuadas, el último miembro puede incorporarse rápidamente, mantener el código y realizar mejoras sin necesitar mucho tiempo para comprenderlo.

Estándares de codificación PHP de WordPress

PHP is WordPress’s core language. Following the PHP coding standards ensures that your code integrates smoothly with WordPress and is easy for others to understand.

1.Etiquetas PHP: Utilice siempre etiquetas PHP completas <?php. Evite etiquetas cortas como <? ?> porque puede que no funcionen en todos los servidores.

<?php
// Your PHP code here
?>

2.Codificación de archivos: Guarde sus archivos PHP en UTF-8 sin marca de orden de bytes (BOM).

3.Finales de línea: Utilice los finales de línea al estilo Unix (\n).

4.Sangría: Utilice tabuladores para la sangría (no espacios). Esto mantiene el código consistente a través de diferentes editores.

Convenciones de denominación

1.Funciones y métodos: Utilice letras minúsculas y guiones bajos.

function get_user_data( $user_id ) {
    // Código de la función
}

2.Variables: Igual que las funciones: minúsculas y guiones bajos.

1TP4Nombre_usuario = 'John Doe';

3.Clases: Utilice palabras en mayúsculas (StudlyCaps).

clase UserProfile {
// Código de clase
}

4.Constantes: Todas las letras mayúsculas con guiones bajos.

define( 'MAX_UPLOAD_SIZE', 1048576 );

Espacios en blanco y sangría

1.Espacios después de las comas: Cuando enumere parámetros o elementos de la matriz, incluya un espacio después de cada coma.

$colors = array( 'rojo', 'verde', 'azul' );

2.Estructuras de control: Coloque un espacio entre las palabras clave de control y el paréntesis de apertura.

if ( $condition ) {
    // Código
}

3.Operadores: Incluya espacios alrededor de los operadores de asignación, comparación y lógicos.

$otal = $precio + $impuesto;
if ( $total > 100 ) {
    // Código
}

Estructuras de control

1.Colocación de los tirantes: Utilice el estilo Allman, en el que el tirante de apertura está en una nueva línea.

if ( $condition )
{
    // Código
}
else
{
    // Código
}

2.elseif** Palabra clave**: Utilice elseif en lugar de si no.

if ( $condition )
{
    // Código
}
elseif ( 1TP4Otra_condición )
{
    // Código
}

3.Condiciones Yoda: Coloque la constante o literal en el lado izquierdo de las comparaciones.

if ( true === $is_active )
{
    // Código
}

Esto ayuda a evitar la asignación accidental (= en lugar de ==).

Buenas prácticas

1.Evite las etiquetas PHP abreviadas: Utilice siempre etiquetas completas para una mejor compatibilidad.

2.Argumentos de función: Utilice nombres de variables claros y descriptivos.

function calcular_total( $subtotal, $asa_impuesto ) {
    // Código
}

3.Sanitize Inputs: Siempre sanee y valide las entradas del usuario.

$user_id = intval( $_GET['user_id'] );

4.Escapar salidas: Antes de dar salida a los datos, escápelos para evitar problemas de seguridad.

echo esc_html( 1TP4Nombre_usuario );

5.Comentarios: Utilice los comentarios para explicar la lógica compleja o las notas importantes.

// Calcular el precio total con impuestos

Normas de documentación en línea

Una documentación adecuada facilita la comprensión y el mantenimiento de su código.

1.Comentarios de las funciones: Antes de cada función, incluya un bloque de comentarios.

/**
 * Calcula el precio total, impuestos incluidos.
 *
 * @param float $subtotal El importe del subtotal.
 * @param float $tax_rate El tipo impositivo como decimal.
 * @return float El precio total.
 */
function calcular_total( $subtotal, $asa_impuestos ) {
    // Código de la función
}

2.Tipos de parámetro y de retorno: Especifique el tipo de cada parámetro y el valor de retorno.

3.Comentarios Inline: Utilícelos con moderación para explicar partes complejas de su código.

$discount = 0.0; // Inicializar la variable de descuento

Normas de codificación HTML en WordPress

El HTML es la columna vertebral del contenido web. Escribir un HTML limpio y semántico es crucial para la accesibilidad y el SEO.

Directrices generales

1.Doctype: Empiece siempre con el doctype HTML5.

<!DOCTYPE html>

2.Atributo de idioma: Especifique el idioma en el <html> etiqueta.

<html lang="en">

3.Codificación de caracteres: Utilice la codificación UTF-8.

<meta charset="UTF-8">

Estructurar su HTML

1.Elementos semánticos: Utilice elementos semánticos HTML5 como <header>,