代码的命名规则

单词简写

单词超长的可简写、代码内常见的可简写

方法

均小写,用下划线分割,文件名_动作_属性_子属性_子属性的子属性

例如:uart_openuart_writeuart_read_remaininguart_change_baudrateuart_get_xxxuart_is_xxxuart_wait_done

如果方法都在uart结构体里,就不用加前面的uart

方法的参数

类似于局部变量

局部变量

均小写,用下划线分割,类似方法

例如:time_count

单一代替

明显知道是什么意思,虽然有所区别但想统一命名,且范围内只有一个,完全分的清

比如用v代替valuei代替indexf代替函数指针

结构体

结构体命名每个单词以大写开头,后续小写,用大写字母分割

例如:CommunicationModbusIli9341Xpt2046

内部成员变量均小写,用下划线分割

全局数值

均大写,用下划线分割

例如:const UART_BAUDRATE_DEF
DEFdefault

枚举

枚举命名每个单词以大写开头,后续小写,用大写字母分割

例如:BrightnessLevel

内部成员名也是如此,纯数字的开头用下划线

序号

有的东西只是需要加个序号,比如Spi_1 Spi_2,有类似的就要从1开始编码,同一种东西不要有序号的和没序号的混用

相关推荐
Rust研习社1 天前
Once、OnceCell、OnceLock:Rust 一次性初始化终极指南
后端·rust·编程语言
Rust研习社1 天前
从入门到实践:Rust 异步编程完全指南
开发语言·后端·rust
Rust研习社1 天前
Rust Pin 解析:核心原理与异步编程实践
开发语言·后端·rust
圆山猫2 天前
[AI] [Linux] 教我编一个启用rust的riscv kernel用于qemu启动
linux·ai·rust
代码羊羊2 天前
Rust-特征trait和特征对象
服务器·网络·rust
圆山猫2 天前
[AI] [Linux] 教我用rust写一个GPIO驱动
linux·rust
DevilSeagull2 天前
Rust 结构体详解:从定义到实例化的指南
开发语言·算法·安全·rust
圆山猫2 天前
[AI] [RISCV] 用 Rust 写一个 RISC-V BootROM:从 QEMU 到真实硬件
开发语言·rust·risc-v
AI首席情报员_阿布2 天前
Numa:用 Rust 从零造一个 DNS 解析器,顺手解决了开发者最头疼的几件事
人工智能·rust·dns
Rust研习社2 天前
Rust 多线程从入门到实战
开发语言·后端·rust