Documentazione per i test unitari

2

Ho un piccolo progetto scritto principalmente in C ++ che è documentato con Doxygen e testato con un framework di test unitario (Google Test nel mio caso, ma non importa). Ho scritto diversi casi di test per ogni metodo di ogni classe per testare il comportamento del metodo in varie condizioni, e voglio lasciare alcuni commenti per le suite di test. La documentazione di Doxygen è progettata per l'utente di projet, che molto probabilmente non vuole vedere i documenti per i dettagli e i test di implementazione dei progetti.

Voglio sapere qual è la strategia comune della documentazione del test unitario? Non commentarli affatto e considerare i test come documentazione? O forse lasciare commenti non-doxygen nei file di test? Oppure utilizzare l'opzione doxygen ENABLED_SECTIONS per compilare la documentazione di test in modo condizionale?

    
posta Sergey 07.07.2016 - 13:59
fonte

1 risposta

1

ENABLED_SECTIONS è la strada da percorrere. Quindi puoi facilmente accenderli per quelli che li vogliono (te stesso, colleghi, manutentori) e disattivare quelli che non lo fanno (l'utente del progetto).

Questo è ciò che facciamo & funziona bene.

    
risposta data 07.07.2016 - 15:30
fonte

Leggi altre domande sui tag