⛳ Java开发命名规范（嵩山版）

⛳ Java开发命名规范（嵩山版）

🎨 一、命名风格

1. 【强制】代码中的命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束。

   反例：_name / __name / $name / name_ / name$ / name__

2. 【强制】所有编程相关的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式。

   说明：正确的英文拼写和语法可以让阅读者易于理解，避免歧义。注意，纯拼音命名方式更要避免采用。

   正例：ali / alibaba / taobao / cainiao/ aliyun/ youku / hangzhou 等国际通用的名称，可视同英文。

   反例：DaZhePromotion [打折] / getPingfenByName() [评分] / String fw[福娃] / int 某变量 = 3

3. 【强制】代码和注释中都要避免使用任何语言的种族歧视性词语。

   正例：日本人 / 印度人 / blockList / allowList / secondary

   反例：RIBENGUIZI / Asan / blackList / whiteList / slave

   ​ Asan : （俄、塞、罗）阿桑

   ​ blackList : 黑名单 、将…列入黑名单

   ​ whiteList ：白名单、将…列入白名单

   ​ slave ： 奴隶，苦工

4. 【强制】类名使用 UpperCamelCase 风格，但以下情形例外：DO / BO / DTO / VO / AO / PO / UID 等。

   正例：ForceCode / UserDO / HtmlDTO / XmlService / TcpUdpDeal / TaPromotion

   反例：forcecode / UserDo / HTMLDto / XMLService / TCPUDPDeal / TAPromotion

5. 【强制】方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风格。

   正例： localValue / getHttpMessage() / inputUserId

6. 【强制】常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚，不要嫌名字长。

   正例：MAX_STOCK_COUNT / CACHE_EXPIRED_TIME

   反例：MAX_COUNT / EXPIRED_TIME