代码的命名规则

单词简写

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

方法

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

例如: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开始编码,同一种东西不要有序号的和没序号的混用

相关推荐
shimly1234562 小时前
(done) 速通 rustlings(20) 错误处理1 --- 不涉及Traits
rust
shimly1234562 小时前
(done) 速通 rustlings(19) Option
rust
@atweiwei2 小时前
rust所有权机制详解
开发语言·数据结构·后端·rust·内存·所有权
shimly1234562 小时前
(done) 速通 rustlings(24) 错误处理2 --- 涉及Traits
rust
shimly1234563 小时前
(done) 速通 rustlings(23) 特性 Traits
rust
shimly1234564 小时前
(done) 速通 rustlings(17) 哈希表
rust
shimly1234564 小时前
(done) 速通 rustlings(15) 字符串
rust
shimly1234565 小时前
(done) 速通 rustlings(22) 泛型
rust
yezipi耶不耶6 小时前
我在 RTMate 里使用的高并发连接管理利器: DashMap
websocket·rust
初恋叫萱萱11 小时前
深入解析 Rust + LLM 开发:手把手教你写一个 AI 运维助手
运维·人工智能·rust