1. 目的
   良好的代码编写风格是高质量代码的一部分，统一的、良好的代码编写规范，使代码更具可读性与可维护性。本文综合了国内各大厂的编码规范，各取各大厂的各规范中的要点与精华，汇聚成此文档。

2. 文件
   2.1 所有文件统一使用 utf-8 编码
   2.2 包含头文件时，建议相同模块的头文件放在一起

3. 注释
   注释推荐使用英文，英文描述不清楚的可使用中文。

3.1 文件头信息
所有.c, .h 文件都必须带有文件头信息，采用 doxygen 格式，方便以后文档生成。

/**
* @file test.c
* @author Jason Zhu
*
* @brief This file is just for demo.
*
*/

3.2 函数头信息
外部函数要加函数头，内部函数如果功能简单，函数名已经说明一切可不加函数头。
需要进行注释的函数，按下面的格式进行注释，包括：函数功能、输入参数，返回值说明。

/**
* @brief This is a test function
*
* @param param1 The first parameter
* @param param2 The second parameter
* @return uint32_t* The test result
*/
uint32_t *TestFunc(uint32_t param1, uint32_t param2)

.3 代码注释

1. 在代码前面注释使用“/** */”, 在代码右边注释使用“/**< /”。
   注释内容与“”间留一空格