Browse Source

Updated files

master
adiao 3 years ago
parent
commit
9b2f40adf9
  1. 15
      项目命名/项目命名格式.md

15
项目命名/项目命名格式.md

@ -6,13 +6,14 @@
好的命名能体现出代码的特征,含义或者是用途,让阅读者可以根据名称的含义快速厘清程序的脉络。不同语言中采用的命名形式大相径庭,Java 中常用到的命名形式共有三种,既首字母大写的 UpperCamelCase,首字母小写的 lowerCamelCase 以及全部大写的并用下划线分割单词的 UPPER_CAMEL_UNSER_SCORE。通常约定,类一般采用大驼峰命名,方法和局部变量使用小驼峰命名,而大写下划线命名通常是常量和枚举中使用。 好的命名能体现出代码的特征,含义或者是用途,让阅读者可以根据名称的含义快速厘清程序的脉络。不同语言中采用的命名形式大相径庭,Java 中常用到的命名形式共有三种,既首字母大写的 UpperCamelCase,首字母小写的 lowerCamelCase 以及全部大写的并用下划线分割单词的 UPPER_CAMEL_UNSER_SCORE。通常约定,类一般采用大驼峰命名,方法和局部变量使用小驼峰命名,而大写下划线命名通常是常量和枚举中使用。
| 类型 | 约束 例 | 类型 | 约束 | 例 |
| 项目名 | 全部小写,多个单词用中划线分隔‘-’ spring-cloud |:-----|:----------------------------|:------------|
| 包名 | 全部小写 com.alibaba.fastjson | 项目名 | 全部小写,多个单词用中划线分隔‘-’| spring-cloud|
| 类名 | 单词首字母大写 Feature, ParserConfig,DefaultFieldDeserializer | 包名 | 全部小写 |com.alibaba.fastjson|
| 变量名 | 首字母小写,多个单词组成时,除首个单词,其他单词首字母都要大写 password, userName | 类名 | 单词首字母大写| Feature, ParserConfig,DefaultFieldDeserializer|
| 常量名 | 全部大写,多个单词,用’_'分隔 CACHE_EXPIRED_TIME | 变量名 | 首字母小写,多个单词组成时,除首个单词,其他单词首字母都要大写| password, userName|
| 方法 | 同变量 read(), readObject(), getById() | 常量名 | 全部大写,多个单词,用’_'分隔| CACHE_EXPIRED_TIME|
| 方法 | 同变量 |read(), readObject(), getById()|
### 二,包命名 ### 二,包命名

Loading…
Cancel
Save