因為要經常閱讀一些原始碼英文文件,所以今天把一些常用的doxygen關鍵字合集記錄下來,以便以後查閱;
同事也可以方便其他有需要的人能夠看到;
下面是我個人認為比較常用的標記:
@author
作者@brief
摘要@version
版本號@date
日期@file
檔名,可以預設為空,doxygen會自己加
@class
類名@param
函式引數
@return
函式返回值描述
@exception
函式拋異常描述
@warning
函式使用中需要注意的地方
@remarks
備註@see
see also欄位
@note
brief下空一行後的內容表示詳細描述,但也可以不空行用note表示
@par
開始乙個段落,段落名稱描述由你自己指定,比如可以寫一段示例**
@code
引用**段
@endcode
引用**段結束
@pre
函式前置條件,比如對輸入引數的要求
@post
函式後置條件,比如對系統狀態的影響或返回引數的結果預期
附帶我感覺不太會常用到的其他標記:
@defgroup
模組名@name
分組名@
模組結束
@deprecated
今後可能將被廢棄或已經有替代品的函式
@since
從哪個版本後開始有這個函式的
@todo
被標記的**會在todo列表中出現
@bug
被標記的**會在bug列表中出現
@test
被標記的**會在test列表中出現
- 一級專案符號
-# 二級專案符號
mysql常用語法 MySQL常用語法
更新資料 update 表名 set 健名 更改的值 where 建 刪除資料 delete from 表名 where 索引 create index 索引名稱 on 表名 鍵名 建立試圖 create view 檢視名 鍵,鍵 as select matchno,abs won lost fro...
mysql基本常用語法 mysql 常用語法
1.1.開啟 service mysql start 1.2.關閉 service mysql stop 1.3.重啟 service mysql restart 2.1.密碼明文 語法 mysql u使用者名稱 p使用者密碼 舉例 mysql uroot p123456 2.2.密碼密文 語法 m...
wiki常用語法
公司啟用了streber執行部分專案管理工作。streber基於wiki系統建立。在streber中,我們可以建立專案 project 可以為專案建立milestone task等等。與其他專案管理系統一樣,可以為每乙個task分配資源,指定執行時間。由於streber基於wiki組建,具備了wik...