Convenzioni per la stesura del codice

Pubblicato il 21 Luglio 2014

Per una buona leggibilità e manutenibilità del codice dei propri progetti, è estremamente importante stabilire e rispettare delle convenzioni per la stesura del codice. I programmatori esperti, abituati a utilizzare Framework MVC, sanno bene di cosa parlo. Per quelli più inesperti, questo, è un articolo che vale la pena leggere 😉

Per portare avanti lo sviluppo di un progetto è importante avere metodo di lavoro e una buona organizzazione. Il modo in cui si scrive il codice è un fattore fondamentale non solo in fase di sviluppo ma, anche, per future implementazioni: riaprire i file di un vecchio progetto può portare rapidamente al suicidio in caso di spaghetti code 😀

Se il codice è stato ben scritto, in modo pulito e organizzato, non si avrà alcuna difficoltà a rimetterci mano. Per questo, stabilite delle convenzioni e rispettatele. Sempre.

Ecco quelle che seguo io, ispirate dal framework che uso, quasi sempre, per lo sviluppo in PHP.

01) Indentazione

L’indentazione è importante per facilitare la lettura così come un tab lungo 4 spazi per separare diversi blocchi di codice.

02) Commenti

Per documentare il lavoro utilizzo la sintassi di phpDocumentor.

03) Nomi dei file

I nomi dei file li scrivo in minuscolo e separo le parole con un underscore: mio_file.php

04) Nomi delle variabili

I nomi delle variabili (così come delle classi o dei controller in caso di utilizzo di un framework) li scrivo in camelCase: $miaVariabile = 1;

05) Nomi delle tabelle del database

I nomi delle tabelle del database li scrivo in minuscolo e separo le parole con l’underscore, come per i file. Ma, qui, scrivo l’entità al plurale (ad esempio, la tabella degli utenti la chiamerò users). In caso di relazioni tra tabelle, la chiave esterna, la scrivo specificando il nome della tabella al singolare più “_id”: user_id

Si possono stabilire altre convenzioni. Queste che ho elencato sono quelle, per me, fondamentali. Quando progetti lo sviluppo di un’applicazione, adotta un pattern architetturale, serviti di un buon framework e stabilisci e rispetta delle convenzioni. Dici no allo spaghetti code e, forse, ti vorrò bene. Forse eh 😀

PHP Permalink: perchè e come crearli

JavaScript, ecco come mostrare o nascondere un DIV

ER Model Generator: un tool per creare modelli E-R

Condividi il post con i tuoi amici o colleghi