Devo eseguire il backup dei file di implementazione in una mia libreria, oltre alle intestazioni?

1

Sono in procinto di scrivere commenti Doxygen per questa mia biblioteca; è una libreria di intestazione, in gran parte C ++, ma ha un codice che viene collegato anziché incluso.

Per quel codice, che ha intestazioni .h / .hpp - dovrei aggiungere anche commenti Doxygen nel file .cpp, perché la libreria sia "correttamente" documentata, con lo stesso livello di estensività dei commenti delle intestazioni? per esempio. dovrei avere commenti a livello di file e commenti dettagliati a livello di funzione sul codice statico (file-scope)?

PS - Nel caso sia pertinente (probabilmente non lo è): link alla biblioteca attuale su GitHub.

    
posta einpoklum 28.03.2017 - 21:51
fonte

1 risposta

3

Le regole generali sono che i commenti dovrebbero essere dove ne hai bisogno quando si mantiene il codice e che la documentazione dovrebbe includere ciò che è rilevante per il lettore. Di conseguenza tutti i tuoi file dovrebbero contenere intestazioni e commenti a livello di funzione, ma normalmente i soli metodi pubblici devono essere nella documentazione utente generata da Doxygen.d

    
risposta data 29.03.2017 - 08:56
fonte

Leggi altre domande sui tag