Documentazione e revisione del codice

Il consiglio di non scrivere la documentazione del codice dopo aver scritto il codice è, in generale, un buon consiglio. Quello che accade però in pratica è che viene puntualmente disatteso.

Come rimediare allora?

Ad esempio introducendo nel processo di sviluppo una fase di revisione del codice, accompagnata dalla scrittura della documentazione. Ancora meglio se questa documentazione finisce nei commenti al codice sorgente, come si fa con doxygen e compagni.

La revisione e scrittura della documentazione può essere fatta profiquamente anche dall'autore del codice sorgente. E garantisco che il numero di errori o di potenziali problemi scoperti non è trascurabile.