некоторые сомнения по поводу стиля комментариев кода C

Question

У меня есть некоторые сомнения по поводу стиля комментариев кода Си. как это:

/* \brief Creates a new shm pcm */

иногда это так:

/* \!brief Creates a new shm PCM */

В чем разница между "\ краткое" и "\! краткое"

Answer 1

Это комментарии, предназначенные для DoxyGen , системы для генерации документации из исходного кода.

Для компилятора разницы нет абсолютно.

DoxyGen ожидает, что /*! */ и /** */ отметят, что для него предназначены комментарии, см. документацию .

Как уже упоминалось, Альберт выглядит так в src / pcm/pcm.c Несколько лет назад кто-то перепутал /*! \brief ... с /* \!brief