C 注釋和doxygen注釋

2022-08-23 14:33:13 字數 1268 閱讀 9840

c++的注釋只有兩種:

單行注釋,以「//」開頭;

段落注釋,以「/*」開始,以「*/」結束。

int value; //

value是乙個整型變數,這是一句單行注釋

/*test是乙個測試用的類

這是一段注釋中的一行

這是一段注釋中的另一行

*/class

test ;

參照上文c++注釋的分類方式,doxygen注釋可以這樣劃分:

前置單行注釋,以「///」開頭;

後置單行注釋,以「///<」開頭,緊跟**後面;

段落注釋,以「/**」開始,以「*/」結束。

doxygen注釋不單止是給人看的,在生成文件的時候,程式需要根據約定的語法來識別注釋和**的相對位置,因此doxygen的單行注釋可分為前置和後置兩種:

///

value0是乙個整型變數,這句注釋在**的前面

intvalue0;

int value1; ///

< value1是乙個整型變數,這句注釋在**的後面

段落注釋也可以分為前置和後置兩種,但後置的段落注釋意義不大,我反對同學們寫後置的段落注釋:

/*

*test是乙個測試用的類

這是一段注釋語句中的一行

這是一段注釋語句中的另一行

*/class

test ;

doxygen安裝資料夾下的examples\afterdoc.h,內容如下:

/*

! a test class

*/class

test

;

void member(); //

!< a member function.

protected

:

int value; /*

!< an integer value

*/};

採用上文的3個語法規則重新調整一下,是不是頓覺豁然開朗了呢?

/*

* a test class

*/class

test

;void member(); ///

< a member function.

protected:

int value; ///

< an integer value

};

系列文章索引:

Doxygen注釋命令

1 輸出 dstatus value instruction sta noinit 0x01 drive not initialized sta nodisk 0x02 no medium in the drive sta protect 0x04 write protected 效果為 4 以黑體...

Doxygen的注釋規則

注釋格式 或 或 或 常用關鍵字列表 關鍵字標籤名功能描述 生成乙個黑心圓.指定按順序標記。指定連線函式功能。注 空格和 有連線功能,但建議還是使用 只對函式有用。mainpage 首頁描述內容,並將注釋提到首頁標籤中去 section 開始乙個段落,段落名稱描述由你自己指定 file 檔名,可以預...

C語言中的Doxygen注釋模板

嵌入式c語言開發中通常使用doxygen進行文件的生成。doxygen支援多種格式,非常靈活,但排版不好就會顯的比較雜亂,不便於閱讀。下面給出乙份注釋模板。file brief this is a brief description.details this is the detail descri...