这是我参与「第五届青训营 」伴学笔记创作活动的第 4 天 前几天听了让代码更为规范内容的网课，我也分享一些有关的经验与见解，希望能对什么人起到一点点的帮助。
- 规范
- 关于命名：命名的关键是能准确达意。对于不同作用域的命名，我们可以适当地选择不同的长度。 作用域小的变量（比如临时变量），可以适当地选择短一些的命名方式。除此之外，命名中也可以使用一些耳熟能详的缩写。 我们可以借助类的信息来简化属性、函数的命名，利用函数的信息来简化函数参数的命名。命名要可读、可搜索。不要使用生僻的、不好读的英文单词来命名。除此之外，命名要符合项目的统一规范，不要用些反直觉的命名，关键是要在项目中统一。
- 关于注释： 注释的目的就是让代码更容易看懂。只要符合这个要求的内容，就可以将它写到注释里，内容主要包含这样三个方面：做什么、为什么、怎么做。对于一些复杂的类和接口，我们可能还需要写明“如何用”。 注释本身有一定的维护成本，所以并非越多越好。类和函数一定要写注释，而且要写得尽可能全面、详细，而函数内部的注释要相对少一些，一般都是靠好的命名、提炼函数、解释性变量、总结性注释来提高代码可读性。
- 插件
- p3c是阿里巴巴所研发的代码规范插件，规范基于《阿里巴巴Java开发手册》，在IntelliJ IDEA的插件管理中直接搜索Alibaba Java Coding Guidelines即可，p3c会直接在代码逻辑上进行规范扫描，并给出相关建议。
- IntelliJ IDEA是自动保存修改后的文件，然而很多人在开发过程中或多或少会忽略掉代码的书写格式，Save Actions可以在你进行ctrl+S的时候格式化你所在的文件，当然格式的标准是按你目前默认的设置或者是你引入的一些格式插件。
- Alibaba Java Coding Guidelines 专注于Java代码规范，目的是让开发者更加方便、快速规范代码格式。该插件在扫描代码后，将不符合规约的代码按 Blocker、Critical、Major 三个等级显示出来，并且大部分可以自动修复，它还基于 Inspection 机制提供了实时检测功能，编写代码的同时也能快速发现问题所在。
