## 命名规则 * 目录名称统一用 **小写的英文字母、数字** 的组合，其中不得包含汉字、空格和特殊字符； * 文件名称统一用 **小写的英文字母、数字和下划线** 的组合，其中不得包含汉字、空格和特殊字符； * 命名原则的指导思想 * 一是使得你自己和工作组的每一个成员能够方便的理解每一个文件的意义， * 二是当我们在文件夹中使用“按名称排例”的命令时，同一种大类的文件能够排列在一起，以便我们查找、修改、替换、计算负载量等等操作。 * 图片的名称分为头尾两部分，用下划线隔开，头部分表示此图片的大类性质 ~~~ 例如：广告、标志、菜单、按钮等等。 * 放置在页面顶部的广告、装饰图案等长方形的图片取名： banner * 标志性的图片取名为： logo * 在页面上位置不固定并且带有链接的小图片我们取名为 button * 在页面上某一个位置连续出现，性质相同的链接栏目的图片我们取名： menu * 装饰用的照片我们取名： pic * 不带链接表示标题的图片我们取名： title 范例：banner_sohu.gif banner_sina.gif menu_aboutus.gif menu_job.gif title_news.gif logo_police.gif logo_national.gif pic_people.jpg * 鼠标感应效果图片命名规范为"图片名+_+on/off"。 例如：menu1_on.gif menu1_off.gif ~~~ 1. 【强制】 代码中的命名均不能以 *下划线* 或 *美元符号* 开始，也不能以 *下划线* 或 *美元符号* 结束。 ~~~ 反例： _name / __name / $Object / name_ / name$ / Object$ ~~~ 2. 【强制】 代码中的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式。 说明：正确的英文拼写和语法可以让阅读者易于理解，避免歧义。注意，即使纯拼音命名方式也要避免采用。 ~~~ 反例： DaZhePromotion [打折] / getPingfenByName() [评分] / int 某变量 = 3 正例： alibaba / taobao / youku / hangzhou 等国际通用的名称，可视同英文。 ~~~ 3. 【强制】类名使用 UpperCamelCase 风格，必须遵从驼峰形式，但以下情形例外：（领域模型的相关命名）DO / BO / DTO / VO 等。 ~~~ 正例：MarcoPolo / UserDO / XmlService / TcpUdpDeal / TaPromotion 反例：macroPolo / UserDo / XMLService / TCPUDPDeal / TAPromotion ~~~ 4. 【强制】方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风格，必须遵从驼峰形式。 ~~~ 正例： localValue / getHttpMessage() / inputUserId ~~~ 5. 【强制】常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚，**不要嫌名字长**。 ~~~ 正例： MAX_STOCK_COUNT 反例： MAX_COUNT ~~~ 6. 【强制】抽象类命名使用 Abstract 或 Base 开头；异常类命名使用 Exception 结尾；测试类命名以它要测试的类的名称开始，以 Test 结尾。 7. 【强制】中括号是数组类型的一部分，数组定义如下：String[] args; ~~~ 反例：请勿使用 String args[]的方式来定义。 ~~~ 8. 【强制】包名统一使用小写，点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用 单数形式，但是类名如果有复数含义，类名可以使用复数形式。 9. 【强制】杜绝完全不规范的缩写，避免望文不知义。 ~~~ 反例： AbstractClass“缩写”命名成 AbsClass；condition“缩写”命名成 condi，此类 随意缩写严重降低了代码的可阅读性。 ~~~ 10. 【推荐】如果使用到了设计模式，建议在类名中体现出具体模式。 说明：将设计模式体现在名字中，有利于阅读者快速理解架构设计思想。 更多命名规则请参考 [每个程序员需掌握的20个代码命名规则](http://blog.csdn.net/crl2518528/article/details/65446490)