смешно выглядящие комментарии - c ++

Question

когда я читаю исходные файлы проектов с открытым исходным кодом, я часто сталкиваюсь с некоторыми странными фразами в комментариях

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

вопросы
1.Что это? (Не было упомянуто, когда я изучал c ++)
2. Есть ли у них какая-либо документация (где)

Answer 1

Это просто комментарии, и поэтому они не имеют особого значения в C ++. Вероятно, они позволяют генератору документации (например, Doxygen ) извлекать данные из комментариев.

Answer 2

Для некоторой разновидности автоматического генератора документации. Другая программа запускает код, ища комментарии, которые вы видите там. Ключевые слова @... определяют, как следует оформлять документацию, и эта программа генерирует симпатичную HTML или печатную документацию непосредственно из исходного кода. Это способ упростить обновление документации с помощью кода.