забавно выглядящие комментарии - C++
когда я прочитал исходные файлы проектов с открытым исходным кодом, я часто сталкиваюсь с некоторыми странными фразами в комментариях
/*
@brief ......
@usage.....
@remarks....
@par....
*/
вопросы
1. Каковы они? (не были упомянуты, когда я изучал C++),
2. У них есть какая-либо документация (где)
2 ответа
Это просто комментарии и как таковые не имеют особого значения в C++. Вероятно, они нужны для того, чтобы генератор документации (например, Doxygen) мог извлекать данные из комментариев.
Это для какого-то автоматического генератора документации. Другая программа пробегает по коду в поисках комментариев, подобных тем, что вы видите здесь. @... определяют, как должна быть составлена документация, и эта программа генерирует красивую HTML или печатную документацию непосредственно из исходного кода. Это способ легче поддерживать документацию в актуальном состоянии вместе с кодом.