STM32C/C++/空白/注释

STM32 中空白和注释的相关内容：

空白

• 代码缩进
  • 在 STM32 的编程中（通常使用 C 或 C++ 语言），合理的代码缩进可以提高代码的可读性。例如，在嵌套的条件判断或者函数调用中，每一层嵌套可以增加 4 个空格或者一个制表符的缩进。比如：

if (condition1) {
    // 缩进的代码块
    if (condition2) {
        // 进一步缩进
    }
}

• 空行分隔
  • 在不同的函数之间、逻辑模块之间使用空行进行分隔。例如，在一个包含多个外设初始化函数的 STM32 程序中，可以在每个初始化函数之间插入空行，使代码结构更加清晰。

void GPIO_Init(void) {
    // GPIO 初始化代码
}

// 这里的空行分隔了不同的函数
void USART_Init(void) {
    // USART 初始化代码
}

注释

• 单行注释
  • 在 STM32 编程中，单行注释使用//。它可以用于对某一行代码进行简单的解释说明。例如，在配置 GPIO 引脚时：

GPIO_InitStructure.GPIO_Pin = GPIO_Pin_0; // 配置引脚 0
GPIO_InitStructure.GPIO_Mode = GPIO_Mode_Out_PP;

• 多行注释
  • 使用/* */进行多行注释。这种注释方式适合对一段复杂的代码或者一个函数的整体功能进行解释。例如：

/*
 * 以下函数用于初始化定时器 TIM2，
 * 设置其预分频系数、自动重装载值等参数，
 * 以实现特定的定时功能。
 */
void TIM2_Init(void) {
    TIM_TimeBaseInitTypeDef TIM_TimeBaseStructure;
    // 定时器初始化代码
}