嵌入式 C 註釋風格
註釋
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;
嵌入式 C 註釋風格