命名规范

命名普遍共识

  1. 普通变量、函数:小驼峰命名法 camelCase
  2. 构造函数、类:大驼峰命名法 PascalCase
  3. 导出常量:大写单词,单词间用下划线分隔
  4. 普通常量:小驼峰 camelCase
  5. 类型:类似匈牙利命名法,在变量名前加上类型前缀,如使用I,E表示interface和枚举,同时使用大驼峰

命名

1. 介绍

2. 名副其实

3. 避免误导

4. 做有意义的区分

```
像Info、Data; a、the、an;无区分意义,
如product、productInfo、productData

```

5. 使用读得出来的名称

如genymdhms -> genarationTimestamp

6. 使用可搜索的名称

单字母名称仅可用于短方法中的本地变量
如:for(int i=0; i<10; i++){}
名称长短应与其作用域大小相对应,常量、变量多处使用应便于搜索
如:
int realDaysPerIdealDay = 7;

7. 避免使用编码

避免:匈牙利语标记、成员前缀

8. 避免思维映射,明确才是王道

9. 类名、对象名:应该是名词或名词短语

避免:manager、processor、data、Info
使用:Customer、WikiPage、Account、AddressParser

10. 方法名: 动词、动词短语

像get、set、add、remove、is、has、can、should、will、get、set、add、remove、is、has、can前缀;如postPayment、deletePage、save

11. 每个概念对应一个词,不要令人困惑

如controler和manager 容易让人困惑,难以区分

12. 别用双关词,一语一义

13. 使用解决方案领域名称,程序员通识技术性名词

14. 先用程序员熟悉的术语,没有再用源自所涉问题领域的名称

15. 添加有意义的语境

如地址信息:addrFirstName、addrLastName、addrStreet、addrCity、addrState、addrZip
posted @ 2023-12-01 17:01  棠梨叶落胭脂色  阅读(106)  评论(0)    收藏  举报