MDK Keil Template 注释模板

在编写程序时，往往要遵循一些规范。良好的代码风格可以提高代码的可读性，方便后期维护和升级。下面是模仿stm32官方hal库源码的代码风格，制作的一些注释模板。

1、在MDK中添加用户注释模板 template

2、常用一些代码注释模板

2.1
定义一个 BSP_DAC_Driver 组，并把 void bsp_dac1_Init(void) 到这个组里。

 /** @defgroup BSP_DAC_Driver
   * @brief xxx driver modules
   * @{
   */ 
     void bsp_dac1_Init(void);
 /** 
   * @}
   */

2.2
把 void bsp_dac2_Init(void)，添加到BSP_DAC_Driver组里。

   /** @addtogroup BSP_DAC_Driver 
     * @{
     */
       void bsp_dac2_Init(void);
   /** 
     * @}
     */

2.3
使用规范的代码注释模式可以增强代码的可阅读性，使用下列几条语句可以实现比较全面的描述。
@brief 简单描述函数功能
@note 注意事项
@param 函数参数
@retval 函数返回值

/**
  * @brief  停止ADC数据转换
  * @note   NONE
  * @param  NONE
  * @retval NONE
  */
void bsp_adc1_stop(void)
{
  ///
}

3、总结

通过MDK的Template功能可以方便地添加用户的代码注释模板，调高代码的质量，方便后续维护和升级。