VScode Doxygen與Todo Tree插件的使用與安裝

引言

程序中代碼注釋的規范和統一性是作為工程人員必不可少的技能，本文在Visual Studio Code的環境下簡單介紹Doxygen與Todo Tree這兩款插件的配置及使用方法

一、Doxygen

1. Doxygen簡介

Doxygen是一個程序的文檔產生工具，可以將程序中的注釋轉換成說明文檔或者說是API參考手冊，從而減少程序員整理文檔的時間。當然這里程序中的注釋需要遵循一定的規則書寫，才能讓Doxygen識別和轉化。

目前Doxygen可處理的程序語言包含C/C++、Java、Objective-C、IDL等，可產生出來的文檔格式有HTML、XML、LaTeX、RTF等，此外還可衍生出不少其它格式，如HTML可以打包成CHM格式，而LaTeX可以通過一些工具產生出PS或是PDF文檔等。

2. Doxygen安裝及使用

插件安裝

使用方法: 在要注釋的函數聲明上一行, 輸入"/**", 然后回車, 就可以自動生成函數參數列表供補充填寫, 同時要自定義參數的時候可以在插件擴展中找到Param Template一項修改, 例如"@param[in] {param}", 然后根據函數形參輸入或輸出, 修改其中的in or out．

二、Todo tree

3. Todo tree簡介

一個注釋/代碼高亮的插件，在vscode中想標識並且高亮一些未完成的事件。可以注釋一些不同的代碼常用符號的顏色，使得設計的程序代碼具有良好的可讀性以及層次感。

4. Todo tree安裝與調試

安裝插件后，File–Preferences–Settings-- 中打開用戶 setting.json文件

最后效果如圖所示，是不是感覺高大上了很多~