蓝图编程经验

1）蓝图OrC++

研发尽量在C++中实现相关逻辑，用于区别是否需要使用C++而不是蓝图的依据包括以下：

1. 是否是单例的功能模块或者基础父类

2. 是否大量使用了RPC通信

3. 是否有着复杂的调用过程

2）关于日志

日志主要用来记录程序中的错误，包括以下错误：

1. 配置错误

主要是策划配置时出现的错误，例如主键不一致、漏配等情况造成的程序无法按照预期执行。

2. 数据错误

主要用于识别程序错误，一半这类错误在程序没有问题的时候不会出现，但是由于是协同开发，不能保证对接上一定没有问题，主要包括参数校验，数据有效性校验等。

3.异常

程序可能出现的异常、系统配置等有利于诊断异常的日志。

3）关于注释

注释主要的作用如下：

1）需求注释

简单说一下需求是什么，一般来说需求注释很少，需求注释对应需求文档中的内容，以及给策划的配置文档中的内容

2）业务注释

对程序结构的说明，例如该变量的含义是，这段代码的作用是，一把的业务分为以下：

1. 初始化：顾名思义，就是对数据按照其存在的意义进行初始化（init）

2. 更新：在特定的操作后，为了保持数据的一致性和有效性，对数据做修改（update、sync）

3. 特殊算法：在某个特殊的需求下，为应对某种情况，对数据做特殊的修改（使用自然语言描述或使用伪代码描述）

3）算法注释

对业务注释中特殊算法进行详细的说明，一般对应需求中比较复杂的文字表述或算法流程图

注释中除了针对参数和结果的说明外，尽量做到一句话把该函数做的事情说明清楚，还最好添加一下说明：

@code：说明涉及到哪些变量，或修改了哪些变量，做了什么操作，例如@code param init

@node：相关的需求、配置

@bug：关于改函数主要是为了修复哪些bug而做的兼容性说明