标识符命名

标识符是变量、函数、类型的名字。起得好,代码像文章;起得差,三个月后自己都看不懂。

1. 概念:硬性规则

2. 正确与错误例子

C
1/* 合法 */
2int count;
3int _tmp;
4int max_speed;
5int Speed2;
6 
7/* 非法 */
8int 2name; // 数字开头
9int my-name; // 连字符
10int my name; // 空格
11int float; // 关键字

3. 概念:好名字的标准

标准差例子好例子说明
见名知意ttemperature_c能看出含义
类型/单位可提示vvoltage_mv单位写进名字
函数用动词getread_adc_value表达动作
长度适中a1b2buf_len不要无意义乱码

4. 实际例子:嵌入式常见命名

C
1const uint16_t DEBOUNCE_MS = 20;
2volatile uint32_t g uptime_ms; // 不推荐空格,示意:全局时间
3uint8_t led_state;
4 
5void delay_ms(uint32_t ms);
6int read_temperature(void);
7void uart_send_str(const char *s);

5. 风格约定(选一种并坚持)