嵌入式代码编写规范

**嵌入式代码编写规范** ————- 该文章是自己总结出来的编码风格，用于规范自己的代码，增强可读性，非标准规范。强制自己形成良好的编码风格，有利于开发大规模程序而不显得杂乱。 参考STM32固件库编码风格和FreeRTOS编码风格。

一、工程文件组织结构

新建工程文件应包含以下全部或部分文件夹：

• usrSrc：用户源文件，用来存放.c文件和其他的源文件。main.c应放在这里。
• usrInc：用户头文件，用来存放.h文件。
• usrDoc：用户说明文档，用来存放用户在开发过程中书写的文档，一般为.txt格式。例如Readme.txt，指令说明等。
• Src：引用库的源文件。
• Inc：应用库的头文件。
• Lib：引用的库文件。
  
  一个工程一定要包含一个main.c文件，只用来存放main函数。其余函数的定义应在相应的.c文件中，声明在相应的.h文件中。

源文件

• 文件头，文件的简介

/*************************************************************************
 * Copyright (c) 2017, Jimbo Zhang 
 * All rights reserved.
 * 
 * File name    :   USB_Ctrl.c
 * Brief        :   USB API source code.
 *               Introduce the main function or content of this document briefly.
 * Revision     :   1.01
 * Author       :   Jimbo Zhang
 * Date         :   2017.03.10
 * Update       :   Introduce the difference from previous version.
*************************************************************************/

• 必要的注释和说明
  源文件应该只包含它自己的头文件，其他的头文件在他自己的头文件中包含。
  源文件中只声明局部函数，全局函数在头文件中声明。
  全局变量在相应的源文件中定义，在头文件中用extern声明。
  类型定义在头文件中定义。

/* Includes -----------------------------------------------------------*/
/*only include it's own header file, the others header file included by USB_Ctrl.h*/
#i