函数注释
/************************************************************************ ◇ 名称: $SymbolName$ ◇ 参数: $MethodArg$ ◇ 返回值: $SymbolType$ ◇ 功能: $end$ ◇ 说明: $selected$ ************************************************************************/
简单版:
// 参数: $MethodArg$ // 说明: $end$
设置方法:
"VAssistX" –> "Visual VAssistX Options" 然后选择 "Suggestions", 再点击 "Edit VA Snippets",
在打开的窗口中选择 "Refactoring" –> "Document Method"
类注释
/*----------------------------------------------------------------------- * 类名: $classname$ * 说明: $end$ -----------------------------------------------------------------------*/
头文件注释
///////////////////////////////////////////////////////////////////////// // 文件名: $FILE_BASE$.$FILE_EXT$ // 说明: $end$ // 创建时间: $DATE$ $HOUR_02$:$MINUTE$ // // 更新日志: /////////////////////////////////////////////////////////////////////////
设置方法:
"VAssistX" –> "Visual VAssistX Options" 然后选择 "Suggestions", 再点击 "Edit VA Snippets",
在打开的窗口中选择 "With Title Only" , 然后选择 "Class Comment" 和 "Header Comment", 并修改.
头文件 类内部注释
//----------------------------------------------------------- // $end$ //-----------------------------------------------------------
实现文件 外部注释
///////////////////////////////////////////////////////////////////////// // $end$ /////////////////////////////////////////////////////////////////////////
设置方法:
"VAssistX" –> "Visual VAssistX Options" 然后选择 "Suggestions", 再点击 "Edit VA Snippets", 在打开的窗口中选择 "All by Title" , 然后添加.
样例
///////////////////////////////////////////////////////////////////////// // 文件名: FindWay.h // 说明: 实现寻路功能的策略模式 // 创建时间: 2015/03/12 21:27 // 更新日志: // // 2015/03/12 21:31 -- 添加 Straight 策略, 实现直线走路, 目标和角色之间不 // 能有障碍. ///////////////////////////////////////////////////////////////////////// #pragma once #include <Windows.h> #include <memory> /*----------------------------------------------------------------------- + 类名: CFindWay + 说明: 寻路策略模式中的抽象类 -----------------------------------------------------------------------*/ class CFindWay { public: CFindWay(); virtual ~CFindWay(); double m_dPointX; double m_dPointY; virtual void GotoPoint() = 0; }; /*----------------------------------------------------------------------- + 类名: CExplicit + 说明: 具体寻路策略, 寻路模式 -----------------------------------------------------------------------*/ class CExplicit : public CFindWay { public: CExplicit(); ~CExplicit(); void GotoPoint(); }; /*----------------------------------------------------------------------- + 类名: Straight + 说明: 具体寻路策略, 直线走路模式 -----------------------------------------------------------------------*/ class Straight : public CFindWay { public: Straight(); ~Straight(); void GotoPoint(); }; /*----------------------------------------------------------------------- + 类名: CFwContext + 说明: 策略模式的环境类, 维护一个 CFindWay 的引用. -----------------------------------------------------------------------*/ class CFwContext { public: CFwContext(std::shared_ptr<CFindWay> strategy); ~CFwContext(); double m_dPointX; double m_dPointY; void GotoPoint(); private: //----------------------------------------------------------- // 通过 shared_ptr(智能指针) 维护一个 CFindWay 的引用. //----------------------------------------------------------- std::shared_ptr<CFindWay> m_strategy; };
#include "FindWay.h" ///////////////////////////////////////////////////////////////////////// // CFindWay 基类 ///////////////////////////////////////////////////////////////////////// CFindWay::CFindWay() { } CFindWay::~CFindWay() { } ///////////////////////////////////////////////////////////////////////// // CExplicit 策略类 ///////////////////////////////////////////////////////////////////////// CExplicit::CExplicit() { } CExplicit::~CExplicit() { } // 说明: 寻路模式 寻路到指定的明文坐标点 void CExplicit::GotoPoint() { } ///////////////////////////////////////////////////////////////////////// // Straight 策略类 ///////////////////////////////////////////////////////////////////////// Straight::Straight() { } Straight::~Straight() { } // 说明: 直线模式 直线走到指定的明文坐标点, 不能有障碍. void Straight::GotoPoint() { } ///////////////////////////////////////////////////////////////////////// // CFwContext 环境类 ///////////////////////////////////////////////////////////////////////// CFwContext::CFwContext(std::shared_ptr<CFindWay> strategy) { m_strategy = strategy; } CFwContext::~CFwContext() { } void CFwContext::GotoPoint() { m_strategy->m_dPointX = m_dPointX; m_strategy->m_dPointY = m_dPointY; m_strategy->GotoPoint(); }