繁体   English   中英

C代码注释样式的一些疑惑

[英]some doubts about the style of C code comments

我对C代码注释的风格有些疑惑。 像这样:

/* \brief Creates a new shm pcm */

有时是这样的:

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

"\brief" 和 "\!brief" 有什么区别

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

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

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

正如阿尔伯特所提到的,几年前在src/pcm/pcm.c中似乎有人感到困惑/*. \brief... /*. \brief.../* \!brief

暂无
暂无

声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.

 
粤ICP备18138465号  © 2020-2024 STACKOOM.COM