Linee guida per l'esecuzione di revisioni del codice e della progettazione

Nelle linee guida riportate di seguito vengono illustrate diverse tecniche per l'esecuzione di revisioni del codice e della progettazione.

Operazioni necessarie

• Effettuare la revisione in modo approfondito.

  Le finalità di una revisione sono la comprensione e l'analisi accurata della progettazione e del codice. Il tempo da dedicare alla revisione dovrebbe essere pari a circa la metà del tempo impiegato nella scrittura del codice o nella pianificazione originaria della progettazione.

• Affidare ai revisori la gestione complessiva della revisione.

  La revisione deve essere basata sul lavoro dei revisori e sui loro commenti. Se viene consentito agli sviluppatori di revisionare il proprio lavoro, è possibile che altri revisori non riescano a rilevare i problemi.

• Leggere la documentazione relativa al codice o alla progettazione prima della riunione dedicata alla revisione.

  A meno che l'incontro non sia destinato alla revisione di modifiche poco rilevanti, è opportuno prepararsi in anticipo. Le riunioni dedicate alla revisione a cui i revisori partecipano senza un'adeguata preparazione e lettura del codice o della progettazione rappresentano una perdita di tempo per tutti i soggetti coinvolti.

• Utilizzare il Portale progetti di Team System per le revisioni di gruppo.

  Pubblicare la documentazione sulla progettazione in un portale del progetto per consentire a tutti di accedere e revisionare con facilità i documenti. Inviare ai revisori un riferimento al documento pubblicato e chiedere loro di aggiungere i propri commenti mediante la funzionalità di discussione di Internet Explorer. Se si desidera che il proprio codice venga revisionato con le stesse modalità, incollarlo in un documento Word e pubblicarlo anche in un sito SharePoint. Per ulteriori informazioni, vedere Pianificazione e rilevamento di progetti.

• Utilizzare un elenco di controllo.

  Nel corso di una revisione è piuttosto frequente che ci si concentri esclusivamente su alcuni aspetti, ad esempio la sicurezza, la gestione degli errori o lo stile. La tentazione di passare ad altre attività dopo aver completato un singolo aspetto è forte. La funzione di un elenco di controllo è di non perdere di vista i numerosi aspetti di cui è necessario tener conto durante la revisione.

• Tenere traccia di tutti i problemi riscontrati durante le revisioni del codice.

  Contrassegnare i problemi come elementi di lavoro, come commenti nel codice o come problemi nei documenti di progettazione per evitare che alcuni vadano persi, rendendo del tutto improduttivo il tempo dedicato alla revisione. Per ulteriori informazioni, vedere Creare un elemento di lavoro.

Operazioni da evitare

• Modificare il codice o la progettazione senza informare i revisori.

  Se vengono rilevati degli errori nella progettazione o nel codice dopo l'invio per la revisione, è necessario resistere alla tentazione di correggerli prima della riunione. Le modifiche apportate prima della riunione potrebbero rendere confusa e meno accurata la revisione e urtare la suscettibilità dei revisori. È consigliabile quindi gestire gli errori rilevati con le stesse modalità utilizzate dai revisori. Annotarli e aggiungerli a tutti gli altri commenti.

Operazioni consigliate

• Includere rappresentanti di tutte le discipline.

  Sebbene non sia sempre possibile affidare la revisione dei progetti e del codice a esperti di discipline diverse dallo sviluppo, i rappresentanti di varie specializzazioni possono contribuire all'identificazione di problemi di difficile individuazione. Un rappresentante, al massimo due, di ogni disciplina è sufficiente. Coinvolgere un numero superiore di esperti allunga i tempi della revisione e ne rende più complessa la gestione.

• Revisionare tutto il codice e le progettazioni.

  Per ottenere un prodotto di qualità, è consigliabile far revisionare tutto il lavoro. Le revisioni devono includere analisi del codice, unit test e documentazione della progettazione all'esterno.

• Prendere in considerazione la creazione di aree di sospensione per gestire le revisioni del codice.

  È possibile creare un'area di sospensione che contiene solo le modifiche che si desidera far esaminare ai revisori. Se si crea un'area di sospensione, le modifiche vengono condivise con i revisori senza archiviarle nel controllo della versione. Per ulteriori informazioni vedere Utilizzo delle aree di sospensione.

Vedere anche

Concetti

Analisi della qualità dell'applicazione tramite gli strumenti di analisi del codice

Miglioramento della qualità del codice con i criteri di archiviazione del progetto team