commenti in cerca divertenti -? C++

Question

quando ho letto attraverso i file di origine di progetti opensource ho spesso incontrato alcune frasi strane nei commenti

/*  
@brief ...... 
@usage..... 
@remarks.... 
@par.... 
*/ 

domande
1.What stanno (non erano menzionati quando stavo imparando C++)
2.Do hanno qualsiasi documentazione (dove)

Answer 1

Sono solo commenti e come tali non hanno alcun significato speciale in C++. È probabile che consentano un generatore di documentazione (ad esempio Doxygen) per estrarre i dati dai commenti.

Answer 2

Questi sono alcuni aspetti del generatore automatico di documentazione. Un altro programma attraversa il codice alla ricerca di commenti come quelli che vedi lì. Le parole chiave @... identificano il modo in cui la documentazione deve essere presentata e quel programma genera piuttosto HTML o documentazione stampata direttamente dal codice sorgente. È un modo per mantenere i documenti aggiornati con il codice più facilmente.