设计文档

• DebugHelp输出

  输出格式统一为：[时间][信息类型][关键字][信息内容][文件(行数)]
  其中时间是自动添加上去的
  接口：

  void CDebugCenter::Output(int nType, LPCWSTR lpcwszKey, LPCWSTR lpcwszMsg, LPCSTR lpFile = NULL, int nLine = 0)

  1. 输出信息类型
     • 错误信息
     • 警告信息
     • 一般信息
  2. 关键字
     关键字是为了方便对输出信息进行筛选查找，可以根据需要把某一功能、流程、模块等一系列相关的输出信息给定一个关键字。
     关键字需要定义两个相应的值：
     OPT_KEY_XXX:关键字字符串，标识该输出信息
     OPT_KEY_XXX_DESC:关键字描述，对该关键字进行备注说明，用于说明文档输出，方便其他人了解
     为了要求开发人员有意识地为自己添加的输出信息加以说明，通过以下宏来定义以上两个值

  #define DEF_CFG_INFO(key, v_key, desc, v_desc)
  LPCWSTR key = v_key;
  LPCWSTR desc = v_desc;
  例:DEF_CFG_INFO(OPT_KEY_SCREEN, L"屏幕记录",OPT_KEY_SCREEN_DESC, L"跟踪服务器屏幕记录收集逻辑")

• 配置说明文档

  1. 命令行生成(beta版服务器才生效)：-cfg [/type 配置类型 [/name 配置名称]]

  配置类型：1为SYS_CFG配置，2为ini配置，3为EVENT_CFG，4为DebugHelp输出关键字说明

  2. COServer3Config模块
     添加COServer3Config模块，集中查看和管理服务器相关配置信息。
     将配置的定义集中到COServer3Config.h，类似DebugHelp输出的关键字定义，在COServer3Config也需要使用DEF_CFG_INFO宏为配置定义配置名和配置说明。
     • 成员变量
       >struct CFG_ITEM
       {
       int nType; // 配置类型，SYS_CFG、ini等
       int nLevel; // 配置级别，根据不同的查询人员呈现不同的配置说明
       LPCWSTR lpcwszName; // 配置名称
       LPCWSTR lpcwszDesc; // 配置说明
       };
       CArrayX m_arrCfgItems;
     • 接口
       >void EnumCfgToFile(LPCWSTR lpcwszFileName, // 指定文件名
       int nType = 0, // 配置类型
       LPCWSTR lpcwszName = NULL, // 配置名称，模糊匹配
       int nLevel = 0); // 指定配置级别
       CStringW GetCfgDesc(int nType, LPCWSTR lpcwszName);
       int GetCfgItems(int nType, int nLevel, CArrayX &arrCfgItems);