项目统一命名规则(个人定制规范)
✅ 适用所有语言:JS / C# / Java / Python / SQL
✅ 规避混淆:不使用数字 0、1,防止与字母 l 视觉混淆
✅ 输入便捷:全程不使用下划线 _,适配笔记本键盘快速录入
✅ 命名格式:首个单词 + 类型数字 + 后续单词
一、数字前置排版原因
将类型数字放置在首个单词后方,是由于绝大多数业务变量使用两个英文单词即可完整描述含义;
更为复杂的语义信息统一在代码注释中补充说明。采用该格式后,绝大多数变量名称均可保持全小写书写,格式规整统一,书写简洁高效。
二、数字固定含义(仅使用 2、3、4、5、6、8)
2 变量 / 数字类型(int、long、状态、ID)
user2、user2id、user2status、user2type
3 方法 / 函数 / 业务动作
save3、user3save、user3read、user3login
4 时间字段(时间戳、创建、更新、登录时间)
create4、user4create、user4update
5 类 / 数据表 / 结构体
user5、user5info、user5data、list5
6 类实例对象
user6、user6item、user6obj
8 字符串 / 文本类型(姓名、标题、备注、内容)
name8、user8name、title8、user8title、remark8
三、格式书写规范
1. 类型数字严格跟随在第一个单词之后
✅ 规范:user2info、user3save、user4create、user8name
❌ 禁止:userinfo2、saveuser3、nameuser8
2. 常规双单词变量全程小写,无需大小写切换
3. 超长多单词名称,后续段落使用驼峰格式区分
比如 system8collectionsGeneric
四、简易记忆口诀
五、实际代码示例
• 数字:user2id
• 字符串:user8name
• 时间:user4create
• 类:user5
• 对象:user6
• 方法:user3save
Dictionary<long, user5> user2list = new Dictionary<long, user5>();
六、本规则核心优势
✅ 绝大多数变量纯小写,输入流畅,无需频繁切换大小写
✅ 数字位置固定,一眼即可识别变量类型
✅ 无下划线、无0/1,笔记本键盘输入高效舒适
✅ 自带数字隔离,天然避免与编程语言关键字冲突
✅ 多编程语言通用,全项目格式统一规范