注释
1. 文件注释
/**
******************************************************************************
* @file
* @author
* @version V1.0.0
- @date 2017-5-7 10:46:21
- @brief This file provides template for all peripherals interrupt service routine.
- @attention
*/
2. 函数注释
/**
- @brief Returns the selected Button state.
- @param Button: Specifies the Button to be checked.
- This parameter can be one of following parameters:
-
@arg BUTTON_KEY: Key Push Button -
@arg BUTTON_RIGHT: Joystick Right Push Button -
@arg BUTTON_LEFT: Joystick Left Push Button -
@arg BUTTON_UP: Joystick Up Push Button -
@arg BUTTON_DOWN: Joystick Down Push Button -
@arg BUTTON_SEL: Joystick Sel Push Button - @retval The Button GPIO pin value.
*/
3. 语句注释
/* ... */
注释放在代码前
变量命名
1. 全局变量
全局变量命令符合以下规则
- 全局变量加 g 前缀 eg: uint_t g_UserCount;
- 静态全局变量加 s 前缀 eg: uint8_t s_EenterTimes;
- 局部变量全部小写，用_分隔单词 eg: uint8_t tmp_val;