文章目录

• 前言
• 一、代码风格
• 二、为什么要这些注释？
• 三、生成的独立模块的代码
• 总结

前言

本篇文章讲介绍一下cubeMX生成代码的风格。

一、代码风格

在main.c中可以看到非常多的注释代码，很多人都不知道这些是用来干嘛的，现在就给大家介绍一下这些注释的作用。

系统头文件放置区域
这里我们可以看到包含了main.h和gpio.h这些都是cubemx为我们生成的文件，这些生成的文件的头文件将会放在这里。

/* USER CODE END Header */
/* Includes ------------------------------------------------------------------*/
#include "main.h"
#include "gpio.h"

我们自己写的头文件放置区域
下面可以看到Private includes这两个单词就代表的是私人的头文件。
我们写的时候要将头文件放入USER CODE BEGIN Includes和USER CODE END Includes之间。

/* Private includes ----------------------------------------------------------*/
/* USER CODE BEGIN Includes *//* USER CODE END Includes */

写代码时一定要严格按照要求，将自己写的代码放入USER CODE BEGIN和USER CODE END中间。

  /* USER CODE BEGIN 2 *//* USER CODE END 2 */

二、为什么要这些注释？

当你修改了cubeMX的配置时重新生成代码，假如你的代码没有严格按照要求写入相应的位置那么重新生成的工程会覆盖你写的代码。所以严格按照要求编写代码是非常重要的。

三、生成的独立模块的代码

之前也和大家介绍过gpio.c和gpio.h了。在cubeMX里面每次配置一个模块都会生成对应的.c和.h文件，当你配置了gpio那么就会有gpio.c和gpio.h的文件生成，当你配置了IIC那么就会有对应的IIC.c和IIC.h。
这些独立的.c和.h文件方便我们去查看对应模块的功能和配置，当需要修改对应模块的时候，我们可以直接手动修改而不需要去cubemx里面再次生成代码了。

总结

这个看起来是一个很小的问题，但是希望大家平时养成好的习惯，这样写出来的代码也会更加规范，不会显得凌乱。