代码规范
<table>
<thead>
<tr>
<th>版本号</th>
<th>制订团队</th>
<th>更新日期</th>
<th>备注</th>
</tr>
</thead>
<tbody>
<tr>
<td>1.0.0</td>
<td>待就业六人组</td>
<td>2019.04.16</td>
<td>参考自《阿里巴巴 Java开发手册1.4.0》</td>
</tr>
</tbody>
</table>
<h2>（一） 命名风格</h2>
<p>1.【强制】代码中的命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束。</p>
<ul>
<li>反例：_name / _<em>name / $name / name</em> / name$ / name__</li>
</ul>
<p>2.【强制】代码中的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式。</p>
<ul>
<li>
<p>说明：正确的英文拼写和语法可以让阅读者易于理解，避免歧义。注意，即使纯拼音命名方式 也要避免采用。</p>
</li>
<li>反例：DaZhePromotion [打折] / getPingfenByName() [评分] / int 某变量 = 3</li>
</ul>
<p>3.【强制】类名使用 UpperCamelCase 风格，但以下情形例外：DO / BO / DTO / VO / AO / PO / UID 等。</p>
<ul>
<li>
<p>正例：MarcoPolo / UserDO / XmlService / TcpUdpDeal / TaPromotion</p>
</li>
<li>反例：macroPolo / UserDo / XMLService / TCPUDPDeal / TAPromotion</li>
</ul>
<p>4.【强制】方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风格，必须遵从 驼峰形式。 </p>
<ul>
<li>正例： localValue / getHttpMessage() / inputUserId</li>
</ul>
<p>5.【强制】常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚，不要嫌名字长。</p>
<ul>
<li>正例：MAX_STOCK_COUNT 反例：MAX_COUNT</li>
</ul>
<p>6.【强制】抽象类命名使用 Abstract 或 Base 开头；异常类命名使用 Exception 结尾；测试类命名以它要测试的类的名称开始，以 Test 结尾。</p>
<p>7.【强制】类型与中括号紧挨相连来表示数组。</p>
<ul>
<li>
<p>正例：定义整形数组 int[] arrayDemo; 在 main 参数中，使用String[] args来定义</p>
</li>
<li>反例：在 main 参数中，使用 String args[]来定义。</li>
</ul>
<p>8.【强制】包名统一使用小写，点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用单数形式，但是类名如果有复数含义，类名可以使用复数形式。</p>
<ul>
<li>正例：应用工具类包名为 com.alibaba.ai.util、类名为 MessageUtils（此规则参考 spring 的框架结构）</li>
</ul>
<p>9.【强制】杜绝完全不规范的缩写，避免望文不知义。</p>
<ul>
<li>反例：AbstractClass“缩写”命名成 AbsClass；condition“缩写”命名成 condi，此类随意缩写严重降低了代码的可阅读性。</li>
</ul>
<p>10.【推荐】为了达到代码自解释的目标，任何自定义编程元素在命名时，使用尽量完整的单词组合来表达其意。</p>
<ul>
<li>
<p>正例：在 JDK 中，表达原子更新的类名为：AtomicReferenceFieldUpdater。</p>
</li>
<li>反例：变量 int a 的随意命名方式。</li>
</ul>
<h2>（二） 代码格式</h2>
<p>1.【强制】大括号的使用约定。如果是大括号内为空，则简洁地写成{}即可，不需要换行；如果是非空代码块则：</p>
<ul>
<li>
<p>左大括号前不换行。</p>
</li>
<li>
<p>左大括号后换行。</p>
</li>
<li>
<p>右大括号前换行。</p>
</li>
<li>右大括号后还有 else 等代码则不换行；表示终止的右大括号后必须换行。</li>
</ul>
<p>2.【强制】if/for/while/switch/do 等保留字与括号之间都必须加空格。</p>
<p>3.【强制】采用 4 个空格缩进，禁止使用 tab 字符。</p>
<ul>
<li>说明：如果使用 tab 缩进，必须设置 1 个 tab 为 4 个空格。IDEA 设置 tab 为 4 个空格时， 请勿勾选 <strong>Use tab character</strong>；而在 eclipse 中，必须勾选 <strong>insert spaces for tabs</strong></li>
</ul>