簡體   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