在Visual Studio使用VAssistX助手可以非常方便的给文件和函数添加注释,增加更多的记录信息,从而方便在时间久后,对代码阅读理解的提示,以及别人后续对代码的维护和BUG修改。
添加头文件注释注释方法:
/********************************************************************
//Copyright (C), 2014-2016, Sichuan Qicheng Technology Development Co.,Ltd.
//Filename : $FILE_BASE$.$FILE_EXT$
//Author : zhoulee
//Date : $DATE$ $HOUR$:$MINUTE$
//Version : 1.0
//Description:
*********************************************************************/
添加函数注释方法:
/*************************************************
// Method : $SymbolName$
// Author : zhoulee
// Date : $DATE$ $HOUR$:$MINUTE$
// Description:
// Returns : $SymbolType$
// Parameter :
// $MethodArgName$:
*************************************************/
VAssistX中其他可用宏定义: