代码的命名规则

单词简写

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

方法

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

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

相关推荐
数据知道1 天前
claw-code 源码分析:从 TypeScript 心智到 Python/Rust——跨栈移植时类型、边界与错误模型怎么对齐?
python·ai·rust·typescript·claude code·claw code
Rust研习社2 天前
深入浅出 Rust 迭代器:从基础用法到性能优化
rust
@atweiwei2 天前
langchainrust:Rust 版 LangChain 框架(LLM+Agent+RAG)
开发语言·rust·langchain·agent·向量数据库·rag
skilllite作者2 天前
自进化 Agent 的 skills 别长成烟囱:从多入口分叉到统一发现与 spec 防火带
人工智能·算法·rust·openclaw·agentskills
Rust研习社2 天前
关于 Rust Option 的那些事:从基础到常用 API 全解析
rust
爱分享的阿Q2 天前
Rust加WebAssembly前端性能革命实践指南
前端·rust·wasm
沉淀粉条形变量3 天前
rust 单例模式
开发语言·单例模式·rust
skilllite作者3 天前
SkillLite 多入口架构实战:CLI / Python SDK / MCP / Desktop / Swarm 一页理清
开发语言·人工智能·python·安全·架构·rust·agentskills
Rust研习社3 天前
深入理解 Rust 闭包:从基础语法到实战应用
rust
Rust研习社3 天前
Rust 时间处理神器:chrono 从入门到实战
rust