martedì 19 aprile 2016

Sysadmin Panics: eliminare i commenti

Quando si produce del codice, in qualunque linguaggio, sia di scripting che di programmazione, i commenti rappresentano una parte fondamentale del sistema stesso. Si prenda esempio da quei progetti che non permettono a buon codice di "colpire" l'albero principale se non è opportunamente commentato e documentato.
L'idea è ovvia: anche se il codice è funzionalmente il migliore del mondo deve essere manutenibile da altre persone, che potrebbero non capire a prima vista (e anche alle viste successive!) il comportamento stesso.

Io credo, ho sempre creduto anzi, nell'importanza dei commenti nel codice, a qualunque livello.
Altri esperti non la pensano come me.
Mi è quindi capitato, mantenendo un sistema composto da diversi server, di trovare alcuni miei script modificati da un giorno all'altro. La modifica era semplice: tutti i commenti erano stati rimossi.
Motivo? Portavano via spazio!

Meglio non commentare sia l'azione che la motivazione.

Vediamo però di essere maliziosi: se si è un dipendente il costo/stipendio non viene stabilito in base al tempo nel quale si risolve un problema, e anzi si cerca di ottimizzare lo stipendio fisso risolvendo piu' problemi nello stesso tempo. E' quindi di importanza strategica la documentazione per una rapida comprensione di cosa un programma/script/task sta tentando di fare.
Se invece si è un consulente esterno, pagato a tempo, il fatto che occorra piu' tempo per leggere e comprendere un programma decommentato non è un problema per il sysadmin stesso, anzi potrebbe essere fonte di ulteriori guadagni...
Pensateci la prossima volta che vi trovate da uno dei due lati della barricata: potreste evitare figuracce o costi inutili.

Nessun commento: