设计文档

  • 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输出关键字说明

    1. COServer3Config模块
      添加COServer3Config模块,集中查看和管理服务器相关配置信息。
      将配置的定义集中到COServer3Config.h,类似DebugHelp输出的关键字定义,在COServer3Config也需要使用DEF_CFG_INFO宏为配置定义配置名和配置说明。
      • 成员变量
        >struct CFG_ITEM
        {
        int nType; // 配置类型,SYS_CFG、ini等
        int nLevel; // 配置级别,根据不同的查询人员呈现不同的配置说明
        LPCWSTR lpcwszName; // 配置名称
        LPCWSTR lpcwszDesc; // 配置说明
        };
        CArrayX<CFG_ITEM> 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<CFG_ITEM> &arrCfgItems);
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 200,392评论 5 470
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 84,258评论 2 377
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 147,417评论 0 332
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 53,992评论 1 272
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 62,930评论 5 360
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,199评论 1 277
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,652评论 3 390
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,327评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,463评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,382评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,432评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,118评论 3 315
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,704评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,787评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,999评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,476评论 2 346
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,057评论 2 341

推荐阅读更多精彩内容

  • PentaQ 开放平台 API 接口一期设计文档 V4
    大名郑日天阅读 325评论 0 1
  • 1. Java基础部分 基础部分的顺序:基本语法,类相关的语法,内部类的语法,继承相关的语法,异常的语法,线程的语...
    子非鱼_t_阅读 31,537评论 18 399
  • 1、输出表结果,表结构可自己通过代码调整,主要思路: a 在java代码中,通过数据库查询语句获取所有表名和表名备...
    雨夜青草阅读 7,818评论 6 16
  • 引言 APP采用object-c纯代码开发,未使用故事面板(storyboard),个别view采用xib(自定义...
    白石洲霍华德阅读 611评论 0 5
  • 当我觉得有些难受的时候,汽车已经行驶了一个小时,头在晕,胃在翻滚。想闭眼睡觉,毫无顾忌的加速、刹车,打断了我这个念...
    Mickyholo阅读 180评论 0 0