7.20.2011

來玩玩Doxygen吧!

最近在幫自己寫的Meshio library整理程式碼,發現自己寫註解的方式花樣一堆又不統一,再者要查找寫過的methods也不太容易,於是就把之前弄了一下就放棄的Doxygen給翻出來,以後寫註解就用它的規則,它也回饋給我一個精美的document...

1. Installation: 官網教學Here 

2. Create a configuration file: 官網教學Here

    輸入doxygen -g會產生一個預設的config檔叫Doxyfile

3. Edit the configuration file: 官網教學Here

    剛剛產生的config檔內容會長這樣,找到自己需要的tag修改後面所給的值就可以了(每個tag上方都有詳細的解釋)


    以輸出html格式的document為例,必要的tag有:
        PROJECT_NAME --> 專案名稱
        OUTPUT_DIRECTORY --> document輸出路徑
        INPUT --> source code路徑
        GENERATE_HTML --> 是否輸出html

4. Write comments: 官網教學Here

    doxygen提供好幾種註解的方式,以下是我選擇的寫法,//!用來寫簡易註解,/*!*/用來寫詳細註解

    ex1. 宣告class的註解




   ex2. 宣告method的註解

    其中,在method宣告的註解中用到了一些特殊的command,例如 \param 和 \return
    欲知其詳細用法和更多commands,請參考官網Special Commands

5. Generate documents: 官網教學Here

    執行doxygen Doxyfile之後進入所指定的document輸出路徑就可以看到建好的document了!


--

7.17.2011

matplotlib!!! python畫圖表的library

經過最近公司的project後發現測試非常重要!!!
既然有測試 就一定要提供數據
人類又比較喜歡看圖!!! (美女圖?!)
所以當然要輸出精美的圖表啦~~~

matplotlib是個可以畫精美圖表的python lib
簡單列一下官網介紹
matplotlib is a python 2D plotting library which produces publication quality figures in a variety of hardcopy formats and interactive environments across platforms.

官方網站有非常非常多的examples
大概常見的例子都可以找到範例拿來改

gallery裏面也有很多畫出來的圖表可以欣賞


測試測試測試測試測試!!!!!

Extensible Multi-Dimensional Simulator

週末和一位以前物理系的學長敘舊,聊了很多有關排球,物理以及生涯規劃的話題!他得知我對計算流體力學很感興趣,便介紹我一個他最近發現的解算方程式的工具,我覺得很有趣,如果工作上有需要解什麼方程式,看看它能不能幫得上忙?!XD

Extensible Multi-Dimensional Simulator



--