Doxygen一些技巧

2021-07-24 09:14:19 字數 1756 閱讀 8488

團隊的**習慣一直不好,注釋五花八門,甚至幾千行**沒有一千行注釋。幾個新進來的成員紛紛抱怨,痛定思痛,決定來一次大刀闊斧的改變。

由於本部門團隊編寫介面的時候比較多,做介面說明文件也是本分內的事情,既能規範注釋,又方便編寫文件,於是想到了doxygen這個神器,也決定使用doxygen的注釋規範。

說實話,幾年前接觸過這個東西,但僅僅玩了下就給扔掉了,並沒有深入,這次玩發現不少有意思的東西。初級的東西咱們不說了,直接用doxywizard搞定,幾個next,配置檔案就搞定了,一般的專案不在話下。這邊有幾個技巧倒是可以說說。

1.識別任意型別檔案

它就把這個ff.zaphx當php檔案來解析了,更多的你也可以試試。

2.**還有一些奇奇怪怪的東西

doxygen原生支援一些簡單的**,看這個示例:

/**

* column1|column2|column3|column4

* --|--|--|--

* row1_content1|row1_content2|row1_content3|row1_content4

* row2_content1|row2_content2|row2_content3|row2_content4

*/

跑下看看,是個漂亮的**:

有些人說沒辦法寫歷史記錄,doxygen好像沒有生成檔案歷史記錄的指令,還好有個標題文字可以用下,也蠻好用的

/**

* 標題

* --

* 這一節的內容

*/

看下效果:

也挺不錯的,然後兩個工具配合使用:

/**

* @file file.name

* @author 作者

* @version 1.0.0.0

* * 更新歷史

* --

* 版本號|說明|修訂者|修訂日期

* ------|----|------|--------

* v1.0.0.0|建立文件|作者|2016-10-08

* */

跑下doxygen,見證奇蹟的時刻:

相當漂亮,除了更新歷史那邊還有些彆扭,比版本什麼的都大一些。

我不是**座,對我來說,這樣就足夠了,但這一點區別能把**座憋屈死,怎麼辦?還有個殺手鐗,直接使用html標籤的指令htmlonly,看這個:

/**

* @file test.auphx

* @author 作者

* @version 1.0.0.0

* * @htmlonly

* 更新歷史

* @endhtmlonly

* 版本號|說明|修訂者|修訂日期

* ------|----|------|--------

* v1.0.0.0|建立文件|作者|2016-10-08

* */

這次不騙你了,真的是奇蹟來了:

效果妥妥的,不騙你。

還有一些word文件中常用的東西,比如這個點「 •」,表示乙個項,doxygen也同樣有這個東西:

/**

* 論點的重要性

* --

* - 專案1

* - 專案2

*/

跑下看看:

玩多了doxygen,簡直停不下來有木有?

等我玩出 更多花來,還有內容奉送。

oracle SQL一些技巧

1 當前時間加7天 select sysdate interval 7 day from dual 2 當前時間減10分鐘 select sysdate interval 10 minute from dual 3 當前時間加3秒 select sysdate interval 3 second f...

一些jquery技巧

window.nl ad function document ready function 相當於 function foo html 相當於 document.getelementbyidx x foo innerhtml jquery 物件轉換成 dom物件 第一種方法 var cr cr jq...

C 一些技巧

一如果函式對傳入的指標引數進行修改,一定要把引數設定為指標的指標或者指標的引用 delete the first occurrence of the node which value equals item in a single linked list void delete node head,...