代码的命名规则

单词简写

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

方法

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

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

相关推荐
数字幽灵4 分钟前
开源!我用 Rust 手搓了一个 Agent 原生的鸿蒙逆向分析平台
rust
Kapaseker1 天前
Rust 不用写 for 循环?看我怎么写!
rust
奶油话梅糖1 天前
打开项目 0.9 秒、内存只有 IDEA 的 1/12:OpenIDEA 用 Rust 把 IntelliJ IDEA 重造了一遍
java·rust·github·intellij-idea
Vex2une2 天前
Google Picasa 精神续作:Rust 重写的离线本地相册工具‌
rust·图片管理·picasa·马良·本地照片管理·重复图片检测·maliang
unconditional3 天前
我拆了 sdkm 的自定义 SDK 机制:所谓“内置”,就是官方提前帮你填好的表
rust·开源
Ramble_Naylor4 天前
Rust深度解读:Send 与 Sync 的本质与线程安全边界
python·算法·rust
Ramble_Naylor4 天前
Rust深度解读:异步流(Async Streams)与生成器的处理艺术
开发语言·后端·rust
RobinDevNotes4 天前
Memvid 把 Agent 长期记忆塞进一个文件
人工智能·rust·openresty
miofly4 天前
GitHub 今日推荐|agent-desktop:通过无障碍树让 AI 代理直接操作桌面应用
rust·开源·github
geovindu4 天前
rust:N-Barrier Pattern
开发语言·后端·设计模式·rust·屏障模式·并发型模式