Ghid de stil pentru un cod curat în programare

Este important să păstrați codul lizibil și ușor de întreținut. Acest lucru previne ascunderea erorilor mici, dar critice în codul dvs., în timp ce face clase întregi de erori incredibil de evidente (lipsă acoladele de închidere sunt ușor de observat atunci când indentați consecvent ).

Deși cel mai bine este să utilizați același standard ca toți ceilalți, dacă vă simțiți mai confortabil să utilizați un standard PSR, atunci folosiți-l. Dacă o faceți, totuși, faceți-o în mod constant.

Indentare

Indentarea în WordPress se face folosind taburi, reprezentând 4 spații vizual. Indentarea este importantă pentru codul care poate fi citit, și fiecare instrucțiune ar trebui să fie pe propria linie. Fără indentare, devine foarte dificil să înțelegeți ce se întâmplă, iar greșelile sunt mai ușor de făcut. De asemenea, acest lucru face ca cererile de asistență pe forumuri și să fie dificil de răspuns la solicitări.

Un editor bun va indenta automat pentru dvs.; majoritatea pot reindenta un fișier dacă aveți cod mai vechi care trebuie reparat.

O modalitate bună de a vă asigura că toți membrii unei echipe folosesc același stil este să utilizați Editor Config. Conține pluginuri pentru diferiți editori, astfel încât toată lumea să-și poată folosi editorul preferat.

De exemplu, următorul fișier .editorconfig impune regula de mai sus, indentarea sub formă de taburi cu lățime de 4 spații.

[*.php] indent_style = tabs
indent_size = 4

Spam cu etichete PHP

Etichetele <?php și ?> ar trebui folosite cu moderație. De exemplu:

<?php while( have_posts() ) { ?>
<?php the_post(); ?>
<?php the_title(); ?>
<strong><?php the_date(); ?></strong>
<?php the_content(); ?>
<?php } ?>

ar fi mai ușor de citit ca:

<?php
while( have_posts() ) {
the_post();
the_title();
?>
<strong><?php the_date(); ?></strong>
<?php
the_content();
} ?>

Un ghid bun este să calculați ceea ce trebuie afișat, apoi să afișați totul dintr-o dată, mai degrabă decât să amestecați cele două.

Linting

Mulți editori acceptă sau au integrat verificatoare de sintaxă. Acestea se numesc Linters. Când utilizați un editor bun, erorile de sintaxă sunt evidențiate sau subliniate.

De exemplu, în PHPStorm, o eroare de sintaxă este subliniată cu roșu.

Sursa: WordPress The Right Way, licența CC BY-SA 4.0. Traducere și adaptare Nicolae Sfetcu