VS2010、VS2012、VS2013的代码自动注释插件。安装该插件后,可以在VS的菜单中显示“注释”主菜单,可以给类、函数、成员添加标准的注释,与Doxygen配合使用,可以直接生成项目的注释文档。
【插件下载】
http://download.csdn.net/detail/aoshilang2249/8497739
https://coding.net/u/aoshilangCode/p/AutoComment/git
【插件安装】
下载后,直接双击安装
【安装效果】
【使用效果】
实际使用时,将光标放在需要添加注释的类名、函数名、变量名上,再选择对应的菜单即可以添加对应的注释了。
//====================================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);
}
};