A ottobre ho dovuto modificare il plugin Eshop (di cui ho dato un resoconto in questo articolo per Html.it) in modo radicale. A dicembre ho dovuto effettuare alcune correzioni sul codice e francamente mi sono trovato in difficoltà perchè non ricordavo nel modo più assoluto a cosa servivano alcune routine scritte solo due mesi prima. Questo mi ha portato a considerare l'importanza dei commenti PHP anche in ambiente WordPress. Vediamo perchè.
Anche se la maggioranza del codice che scriviamo per WordPress è procedurale (infatti su WordPress non utilizzo la notazione camel-case dell'OOP come in Zend ma uso gli underscore), un commento al posto giusto può fare la differenza nel tempo.
Per esempio, considerate questo codice usato per modificare il carrello di Eshop:
$agent_cart = $_SESSION['eshopcart'.$blog_id];
if(isset($_POST['sconto'])) {
$sconti = $_POST['sconto'];
$prodotti = $_POST['sconto-prodotto'];
$sconto = -1;
foreach($agent_cart as $item => $value) {
$sconto++;
if($sconti[$sconto] != '') {
$val = $sconti[$sconto];
$agent_cart[$item]['prezzo-scontato'] = calculate_discount($value['price'], $val);
$agent_cart[$item]['sconto'] = $val;
}
}
}
In pratica ho eseguito un loop nell'array associativo del carrello di Eshop ed ho aggiunto le voci prezzo-scontato e sconto. Per ottenere questo risultato ho dovuto eseguire un ulteriore ciclo all'interno dell'array composto dai campi di sconto.
Quindi sarebbe stato sufficiente aggiungere il seguente commento dettagliato:
/* Modifico il carrello di Eshop aggiungendo al suo array associativo due nuove voci
* ottenute accedendo all'array di sconti e utilizzando la funzione calculate_discount()
* per avere il prezzo scontato
*/
Vorrei enfatizzare quest'uso pratico dei commenti in WordPress perchè sull'uso dei commenti in stile PHPDoc si è già discusso abbastanza per quanto riguarda i metadati aggiunti ai temi ed ai plugin.
Da un punto di vista della produttività i commenti ci evitano di dover rianalizzare il codice a distanza di tempo e ci permettono di eseguire più velocemente le modifiche richieste.