项目中的规范命名

项目命名（Project Naming）

全部小写：包名应该全部使用小写字母。使用"-"隔开。

例如："sky-take-out"

包命名（Package Naming）

• 全部小写：包名应该全部使用小写字母。
• 域名反转：通常使用公司或组织的倒置域名作为包名的前缀，例如com.example.project。
• 层次结构：包名应反映项目的层次结构，例如com.example.project.utils。

类命名（Class Naming）

• 大驼峰式：类名应该使用大驼峰式命名法（每个单词的首字母大写），例如Customer、OrderProcessor。
• 名词：类名通常为名词，表示它是一个对象或实体。
• 避免缩写：除非缩写是广泛认可的，否则应避免使用缩写。

接口命名（Interface Naming）

• 大驼峰式：与类命名相同，使用大驼峰式。
• 形容词或名词：接口名可以是形容词，表示它描述的能力，例如Serializable；也可以是名词，表示它是一个角色或职责，例如Repository。

方法命名（Method Naming）

• 小驼峰式：方法名应该使用小驼峰式命名法（第一个单词首字母小写，后续单词首字母大写），例如getCustomerInfo()、calculateTotal()。
• 动词开头：方法名通常以动词开头，表示动作或操作。
• 清晰描述：方法名应清晰描述该方法的功能或返回值。

变量命名（Variable Naming）

• 小驼峰式：与方法命名相同，使用小驼峰式。
• 描述性：变量名应具有描述性，表明其用途或内容。
• 避免单字母：除非是临时变量或循环索引，否则避免使用单字母命名。

常量命名（Constant Naming）

• 全部大写：常量名应该全部使用大写字母，单词之间用下划线分隔，例如MAX_VALUE、DEFAULT_TIMEOUT。
• 静态final：常量通常是静态的（static）和最终的（final）。

枚举命名（Enum Naming）

• 大驼峰式：枚举名使用大驼峰式。
• 单数形式：枚举名通常使用单数形式，例如Color、Status。
• 枚举值：枚举值通常使用大写字母，单词之间可以不用分隔符，例如RED、GREEN。

注释和文档

• 清晰明了：注释应清晰明了，解释代码的目的、功能或复杂逻辑。
• JavaDoc：使用JavaDoc标准为类、方法和公共属性提供文档注释。