Newsgroup: it.comp.programmare
Titolo: Re: Estetica dei sorgenti

 e come affrontate voi la manutenzione di quel che scrivete?
In effetti e' un problema arduo che richiede un insieme di regole
a monte e la pazienza di ristrutturare sempre il codice nella maniera
migliore senza lasciarsi tentare dalla pigrizia...
Lasciare #if.. qua e la' senza preoccuparsi di fare pulizia, significa poi
che alla fine ci si ritrova con sorgenti illeggibili e incomprensibili.
Un modo puo' essere quello di tenere moduli piccoli e congruenti,
eliminazione del codice morto, localizzazione del codice di test/debug/
config/systemDependent in moduli specifici, utilizzo di un Version Control
per i sorgenti (per evitare le 1000 copie di copie!)
un po' di buon senso, commenti dove serve sempre aggiornati ;-)
Puoi cominciare a seguire uno standard di sviluppo con le tue
regole e importi di seguirle...oppure cerca in rete tra le N linee guida
proposte e vedi se ti si adattano.
Bye,
B.

eccetera. 
Ahimé ti capisco. Gran parte di questi problemi sono dovuti alla paura
di perdere le modifiche e a quella di introdurre nuovi bug e così il
codice finisce per essere nascosto dietro una costante impalcatura,
che consenta un continuo ritorno sui propri passi. Risultato: un
disastro dal punto di vista manutentivo. La prima cosa da fare è
eliminare entrambe le fobie: la prima (perdere le modifiche) si
risolve usando un sistema di versioning dei sorgenti (sì, anche se
lavori da solo) e la seconda (introdurre bug) mediante l'uso
sistematico dei test. I test sono fondamentali nello sviluppo e
purtroppo una pratica molto bistrattata da molti. Oltre al necessario
rigore da adottare ed imporre agli altri, le linee guida di stile per
il codice, la documentazione automatica, un corretto uso dei commenti,
vedrai che con un Version Control System e l'uso dei test gran parte
delle tue preoccupazioni spariranno.

 la documentazione automatica, 
Ecco, se dovessi fare un /mea culp/ questo sarebbe il primo punto da cui 
partire. :-P
Ciao,
Giulio
-- 
OnAir: J.S.Bach - "Allegro" dal Concerto Brandeburghese n°2 (in Fa Maggiore)
http://www.giuliopetrucci.it
http://www.fujikomonamour.com

partire. :-P
Mah, dipende. Il fatto è che in un ipotetico ordine, sarebbe
sull'ultimo gradino. Alla fine anche del codice molto ben scritto va
bene. 

 bene. 
Finché sviluppo codice per uso personale o interno, ci può anche stare. 
Ma se rilascio una libreria con delle API allora... ;-) Come era la 
regiola d'oro? "Non fare agli altri ciò che non vuoi gli altri facciano 
a te"... ecco: io se devo usare una libreria di terze parti non 
documentata mi innervosisco all'inverosimile! ;-)
Ciao,
Giulio
-- 
OnAir:
http://www.giuliopetrucci.it
http://www.fujikomonamour.com

 Ma se rilascio una libreria con delle API allora...
Non fraintendere. Non sto dicendo che il software non vada documentato. Se
rilasci un'API documentata solo nel codice, sei un criminale. Di solito
un'API ha una manualistica completa. Io sto dicendo una cosa diversa e
cioè che tutte le precauzioni che vengono prese perché il codice sia
auto-esplicativo possono ridurre moltissimo il ruolo dei commenti o della
documentazione automatica. La documentazione automatica, poi, non
sostituisce un manuale.
-- 
questo articolo e` stato inviato via web dal servizio gratuito 
http://www.newsland.it/news
 segnala gli abusi ad 
ab...@newsland.it