代码的命名规则

单词简写

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

方法

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

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

相关推荐
孙启超3 天前
【AI开发之Rust】第 11 课:智能指针与内部可变性
开发语言·后端·rust
mikuyyds3 天前
geo-toolbox 水文插件算法解析:从 Muskingum 到 Muskingum-Cunge
算法·rust·gis
PC2005-cloud3 天前
Rust学习笔记:模块系统——mod、use、pub与多文件项目
rust
Amos_Web3 天前
Rspack 源码解析(十二):JavaScript Chunk 是如何被渲染出来的
前端·rust·源码
柯南46683 天前
【AI开发之Rust】第 14 课:网络请求与 JSON —— reqwest + serde
rust·编程语言
恋喵大鲤鱼3 天前
Rust 格式化输出占位符详解
rust
孙启超3 天前
【AI开发之Rust】第 13 课:async/await 与 tokio 异步运行时
开发语言·后端·rust
小道士写程序3 天前
Rust + Axum + MySQL + SQLx
rust
mikuyyds4 天前
geo-toolbox 插件算法解析:RUSLE 与 MUSLE 的工程化落地
算法·rust·gis