代码的命名规范有哪些?

代码的命名规范有哪些?

1、命名规范的作用:

让代码更易读、易维护。

2、常用的命名风格:

命名法 中文名 示例 说明
camelCase 小驼峰 userName 首字母小写,后续单词首字母大写
PascalCase 大驼峰 UserName 每个单词首字母都大写
snake_case 蛇形(下划线式) user_name 单词间用下划线分隔
kebab-case 串式(烤肉式) user-name 单词间用连字符分隔
SCREAMING_SNAKE_CASE 常量式 USER_NAME 全大写 + 下划线
Train-Case 火车式 UserName(带连字符 User-Name) 类似帕斯卡但用连字符分隔

代码示例

java 复制代码
// 小驼峰命名示例(camelCase,常用于变量、函数、参数等)
let userName = '张三';
let orderCount = 5;
function getUserDetail(userId) {
  return `获取ID为${userId}的用户详情`;
}

// 大驼峰命名示例(PascalCase,常用于类名、组件名、构造函数等)
class UserOrder {
  constructor(orderId) {
    this.orderId = orderId;
  }
}
function OrderComponent() {
  return `这是订单组件`;
}

3、通用命名原则

(1)见名知意:getUserById 优于 getU。

(2)避免缩写歧义:temp 可以,但 usrTbl 不推荐(除非团队约定)。

(3)长度适中:作用域越小可以越短,全局变量要足够描述性。

(4)避免保留字和单字母:循环变量 i/j/k 可接受,其他场景避免。

(5)一致性优先:团队统一 > 个人偏好。

(6)布尔命名用肯定式:isEnabled 而不是 isDisabled。

(7)避免数字后缀:user1、user2 通常说明设计有问题。

4、命名不规范的后果

(1)看不懂 ------ 自己过段时间也忘了 a、tmp 是啥意思。

(2)容易改错 ------ 名字和实际含义不符,别人误用、误改,产生 bug。

(3)沟通费劲 ------ 评审、交接时要反复解释,效率低。

(4)工具失灵 ------ 框架、IDE、Lint 靠命名约定工作,命名不对就失效。

(5)越维护越乱 ------ 不敢改只能加,代码越来越臃肿,新人上手慢。

相关推荐
旋律4142 小时前
为什么需要命名规范?有哪些命名规范?
java
2301_786756602 小时前
中科院分区表停发后,期刊评价的技术逻辑:从期刊超越指数到多指标选刊方案
java·数据库·windows
Wx-bishekaifayuan2 小时前
springboot铜仁非遗之家76938-计算机课程设计、毕业设计
java·spring boot·后端·spring·django·课程设计·旅游
顽疲2 小时前
java vue springboot 养老系统源码详解:退住 care_out 审批结算与腾床事务实践
java·vue.js·spring boot·vue养老·springboot养老·java养老
geats人山人海3 小时前
java 7异常
android·java·开发语言
斯内普吖3 小时前
(开源)线上花店系统实战指南 基于 Java + SSM + Vue + MySQL
java·vue.js·mysql·开源
duxingzhe03113 小时前
我的一些书
java·数据库·tomcat·数据库开发·etl工程师
2603_965148113 小时前
商品价格监控 API 接口:从原理到实战的完整指南
java·前端·数据库·python·生活
瑞克-桑切斯3 小时前
2、Shell 条件语句
java·linux·服务器