Il numero del requisito / numero / codice dovrebbe essere incluso nei commenti del codice sorgente? [duplicare]

0

Sto lavorando su una serie di progetti di manutenzione e includo sempre il numero / numero di requisito / codice nei commenti ogni volta che aggiungo o modifichi il codice. In tal modo fornisco la tracciabilità dai requisiti al codice e ritorno. La mia esperienza è che tale sforzo può essere di grande aiuto per la manutenzione successiva, soprattutto se i requisiti cambiano o sono aggiornamenti dovuti a incoerenze iniziali nei requisiti.

Tuttavia, ho visto il codice sorgente di altri progetti che non hanno commenti e posso solo immaginare quale parte del codice sta implementando quale requisito.

Qual è la buona pratica nella tracciabilità di requisiti e commenti?

    
posta TomR 10.07.2017 - 11:46
fonte

1 risposta

3

Dato che tutto in una base di codice è in ultima analisi dovuto a qualche requisito o altro, questo tende a sparpagliare codice con id pervasivi e persino più problemi in ogni sezione. Preferisco di gran lunga avere tali riferimenti nei commenti di commit, che lasciano il codice base pulito per una facile lettura.

La connessione ai documenti dei requisiti può ancora essere effettuata utilizzando la funzione cronologia del sistema di controllo di revisione e poiché la lettura del codice è molto più comune della risoluzione della domanda "Perché e quando è stata specificata questa funzionalità?", è una buona compensare per richiedere un passaggio in più per l'attività più rara, lasciando il più comune non ingombrante.

    
risposta data 10.07.2017 - 11:50
fonte

Leggi altre domande sui tag