有关C代码注释样式的一些疑问

Question

我对C代码注释的样式有疑问。像这样：

/* \brief Creates a new shm pcm */

有时是这样的：

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

“ \ brief”和“ \！brief”有什么区别

Answer 1

这些是针对DoxyGen的注释，DoxyGen是一个从源代码生成文档的系统。

对于编译器，绝对没有任何区别。

DoxyGen期望/*! */并/** */标记注释是针对它的，请参阅文档。

正如阿尔伯特提到的，它看起来像在SRC / PCM / pcm.c几年前，有人困惑/*! \brief ...与/* \!brief