來玩玩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了！


--