对C代码注释的风格有些疑问

问题描述 投票:0回答:1

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

/* \brief Creates a new shm pcm */

有时是这样的:

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

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

c doxygen alsa
1个回答
4
投票
这些是针对DoxyGen的注释,这是一个从源代码生成文档的系统。

对于编译器,完全没有区别。

DoxyGen期望/*! *//** */标记注释专用于此,请参阅the documentation

我假设您将/*! \brief .../* \!brief混淆了>

© www.soinside.com 2019 - 2024. All rights reserved.