diff --git a/项目命名/项目命名格式.md b/项目命名/项目命名格式.md index 79ad4c9..ad1ed79 100644 --- a/项目命名/项目命名格式.md +++ b/项目命名/项目命名格式.md @@ -3,6 +3,7 @@ 每个公司都有不同的标准,目的是为了保持统一,减少沟通成本,提升团队研发效能。所以本文中是笔者结合阿里巴巴开发规范,以及工作中的见闻针对 Java 领域相关命名进行整理和总结,仅供参考。 ## 一,Java 中的命名规范 + 好的命名能体现出代码的特征,含义或者是用途,让阅读者可以根据名称的含义快速厘清程序的脉络。不同语言中采用的命名形式大相径庭,Java 中常用到的命名形式共有三种,既首字母大写的 UpperCamelCase,首字母小写的 lowerCamelCase 以及全部大写的并用下划线分割单词的 UPPER_CAMEL_UNSER_SCORE。通常约定,类一般采用大驼峰命名,方法和局部变量使用小驼峰命名,而大写下划线命名通常是常量和枚举中使用。 类型 约束 例 @@ -12,7 +13,9 @@ 变量名 首字母小写,多个单词组成时,除首个单词,其他单词首字母都要大写 password, userName 常量名 全部大写,多个单词,用’_'分隔 CACHE_EXPIRED_TIME 方法 同变量 read(), readObject(), getById() + ## 二,包命名 + 包名统一使用小写,点分隔符之间有且仅有一个自然语义的英文单词或者多个单词自然连接到一块(如 springframework,deepspace 不需要使用任何分割)。包名统一使用单数形式,如果类命有复数含义,则可以使用复数形式。 包名的构成可以分为以下几四部分【前缀】 【发起者名】【项目名】【模块名】。常见的前缀可以分为以下几种: