Java变量命名应采用小驼峰（camelCase），首字母小写、单词间大写，禁用下划线与空格；布尔变量优先用is/has/can前缀；禁用数字开头、特殊符号、中文及模糊缩写；需语义明确、上下文一致。

小驼峰命名法（camelCase）是Java中最常用的变量命名规范，核心原则是：首字母小写，后续每个单词首字母大写，不使用下划线或空格。它让变量名既符合Java语法要求，又自然表达语义，显著提升代码可读性和团队协作效率。

变量名必须准确反映其用途

命名不是拼凑单词，而是用简洁、具体的词组合出“一眼可知其意”的标识符。模糊缩写或泛泛而词（如tmp、data、info）会削弱可读性。

• ✅ 推荐：userLoginCount、isEmailVerified、maxRetryAttempts
• ❌ 避免：ulc（含义不明）、flag（无法判断代表什么）、obj（完全失去语义）

布尔类型变量优先使用is、has、can等前缀

这是Java社区广泛接受的约定，能让调用方直观理解该变量表达的是状态或能力，也与JavaBean规范兼容（如getXXX()方法对应isXXX()）。

java-api-doc-generator

分析 Java Spring Boot 后端 Controller 代码，自动生成 Markdown 格式的接口文档。当用户说“生成 Java 接口文档”、“生成 API 文档”、“从 Spring 代码生成文档”时触发。

下载

• ✅ 推荐：isActive、hasPermission、canEdit、shouldRetry
• ❌ 避免：active（易被误认为普通属性）、permissionFlag（冗余且非标准）

避免数字开头、特殊符号和中文，慎用缩写

Java变量名必须以字母、下划线（_）或美元符（$）开头，但下划线和$在常规变量中应避免使用（常用于生成代码或框架内部）。数字不能开头；中文虽语法允许，但严重破坏跨环境兼容性和可维护性。

• ✅ 合法且推荐：userId、httpStatusCode、xmlParser
• ❌ 不合法或不推荐：3rdPartyService（数字开头）、user_name（下划线，属蛇形命名）、用户名称（中文）、svc（无上下文时难懂，不如notificationService清晰）

保持一致性并尊重上下文长度

同一作用域内相似概念应采用统一模式。例如一组配置项都用xxxTimeout、xxxRetries；循环中的临时变量可适度简短（如i、item），但在业务逻辑中应完整表达（如orderItem而非oi）。

• ✅ 一致示例：connectTimeoutMs、readTimeoutMs、writeTimeoutMs
• ✅ 场景适配：for (OrderItem item : order.getItems())（item在循环内明确，无需扩展为currentOrderItem）

Java免费学习笔记：立即使用
解锁 Java 大师之旅：从入门到精通的终极指南