个人编码风格

代码规范嘛，对我来讲就像是写字啦，主要还是遵循个人风格，体现自我的审美的东西。网上对此物鼓吹得太过了，规范这东西是上位者用来约束团队，提升效率的方式，但是对大多数人来说，能约束的都只有自己吧- -|，所以嘛，代码规范对我而言就是一种个人的编程风格，如同书写文字的风格一般。
通常，我的基本原则就是：如果整体代码是别人编制，我只是去修改或者增加一小部分，那么放弃自己的风格，不去破坏原本的规范比较好。但是如果大部分代码都是由我来操刀，那肯定是全部安装我的规范来弄。
下方内容想起啥更新啥，每一项肯定不是原创啦，也不知道是从哪里学到的，就一直在这么用。

1 命名的规范

1.1 函数名

驼峰式，小写字母起始，中间的每个单词首字母用大写
例如：

static void insertChar(char s[], char t, int i)

1.2 结构体命名

1.2.1 结构体

结构体名称首字母为类型缩写，之后采用以大写字母起始，中间每个单词首字母大写，其余小写的方式。
类型名称则不需要结构体的缩写，直接以大写字母开始的驼峰式，但是在最后加上_t表示这是一个类型。
例如：

typedef struct sConfigData
{
}ConfigData_t

1.2.2 定义

驼峰式，大小字母起始，中间每个单词首字母均大小。
例如：

ConfigData_t ConfigData;

1.3 一般变量

驼峰式，小写字母起始，中间的每个单词首字母用大写

1.4 常量

常量采用全大写方式，以下划线分割单词，例如

#define LOW_POWER 1

枚举成员适用次规则，但是const 修饰的仍然属于变量，不适用次规则。

2 书写规范

• 赋值的=号两边保留一个空格

  a = b;

• if语句中包含内容如果只有一条，则不写花括号，在此行缩进

  if(1)
      printf("");

• if语句包含类容大于一条，则需要加上花括号

  if(1)
  {
      printf("");
      printf("");
  }

• 条件语句和判断语句的花括号独占一行

  if(1)
  {
  }

• 逗号分隔符右方保留一个空格

  memcpy(Track.time, soleTrack.time, 5);

3 注释

3.1 文件说明

/**
 * @file test.c
 * @brief 
 * @details 
 * @author 
 * @email
 * @version
 * @date
 * @license 版权
*/

3.2 函数说明

/**
 * @brief 函数简介
 *
 * @param 形参 参数说明
 * @param 形参 参数说明
 * @return 返回说明
 *   @retval 返回值说明
 */

3.3 类说明

/**
* @brief 类的简单概述
* 类的详细概述
*/

3.4 变量常量说明

///
变量/常量

变量/常量 ///<

3.5 其他

/**/