代码的命名规则

单词简写

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

方法

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

例如:uart_open、uart_write、uart_read_remaining、uart_change_baudrate、uart_get_xxx、uart_is_xxx、uart_wait_done

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

方法的参数

类似于局部变量

局部变量

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

例如:time_count

单一代替

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

比如用v代替value,i代替index,f代替函数指针

结构体

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

例如:CommunicationModbus、Ili9341、Xpt2046

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

全局数值

均大写,用下划线分割

例如:const UART_BAUDRATE_DEF
DEF是default

枚举

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

例如:BrightnessLevel

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

序号

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

相关推荐
对象存储与RustFS4 小时前
升级 RustFS 二进制不停机:一条一条换,留一条退路
后端·rust·开源
感谢地心引力6 小时前
来试试我做的音乐播放器吧
ai·rust·音乐·navidrome·music·tarui
蚂蚁背大象7 小时前
RocketMQ-Rust 1.0.0 发布:用 Rust 做消息队列,这次有哪些变化?
rust·开源·rocketmq
喵个咪8 小时前
RushWind Admin — 用 Rust 写的企业级中后台,开源了
后端·rust·开源
喵个咪8 小时前
RushWind Admin — 契约驱动:203 条路由零手写的工程化拆解
后端·rust·开源
喵个咪9 小时前
Go 写业务,Rust 扛底盘:一套可落地的混合架构
后端·rust·go
孙启超15 小时前
【AI开发之Rust】第 22 课:一键多平台与工程收尾 —— CI、发布检查与结课
开发语言·后端·rust
对象存储与RustFS1 天前
自建对象存储的第一个决定:单机就够,还是必须上分布式
后端·rust·开源
geovindu1 天前
rust: tree
开发语言·后端·rust
孙启超2 天前
【AI开发之Rust】第 21 课:双端集成与出包 —— Android(.so→AAR)与 iOS(xcframework)
开发语言·后端·rust