全局Java代码规范指南

概述

本指南提供统一的代码编写规范，涵盖命名约定、代码格式、项目结构、注释文档、异常处理、测试规范、依赖管理、安全健壮性以及 AI 代码生成指引。遵循这些规范有助于提升代码质量、可读性和可维护性。

命名约定

类和接口

• 【强制】使用大驼峰命名法（UpperCamelCase）
• 【强制】类名应为名词，接口名可为名词或形容词
• 【强制】抽象类使用 Abstract 或 Base 开头
• 【强制】异常类使用 Exception 结尾
• 【强制】测试类以它要测试的类名开始加 Test 结尾
• 【强制】禁止以下划线或美元符号开始/结束命名