VS2010、VS2012、VS2013、VS2015 程式碼自動註釋外掛【2】
阿新 • • 發佈:2019-02-19
VS2010、VS2012、VS2013的程式碼自動註釋外掛。安裝該外掛後,可以在VS的選單中顯示“註釋”主選單,可以給類、函式、成員新增標準的註釋,與Doxygen配合使用,可以直接生成專案的註釋文件。
【外掛下載】
高版本的VS,可以下載原始碼後,自行編譯使用。
【外掛安裝】
下載後,直接雙擊安裝
【安裝效果】
【使用效果】
實際使用時,將游標放在需要添加註釋的類名、函式名、變數名上,再選擇對應的選單即可以新增對應的註釋了。
//====================================CritSec=================================== /// @brief <對該類進行簡單描述> /// /// <對該類進行詳細描述> //================================================================================ class CritSec { private: CRITICAL_SECTION m_criticalSection; ///< <成員變數說明> public: CritSec() { InitializeCriticalSection(&m_criticalSection); } ~CritSec() { DeleteCriticalSection(&m_criticalSection); } //=====================================Lock()===================================== /// @brief <對函式進行概括說明> /// /// <對函式進行詳細說明> /// /// /// @return <返回值說明,可以配合使用DocGenList或DocGenTable> /// /// @remark <函式特別說明> /// /// @code /// <在此新增示例程式碼> /// @endcode /// /// @sa <可以參考的類或函式,用空格分隔,函式名稱後必須加()> //================================================================================ void Lock() { EnterCriticalSection(&m_criticalSection); } //====================================Unlock()==================================== // <對函式進行描述說明> // // // @return <返回值說明> // // @remark <函式特別說明> // // 修改歷史:1 // 1.修改人:Administrator 2015-03-13 // 修改問題:<簡要說明所修改問題> //================================================================================ void Unlock() { // 修改說明:<詳細說明修改原因及內容> // 修改人: Administrator 2015-03-13 LeaveCriticalSection(&m_criticalSection); } };