自从2011年进入高中后接触编码的课程,学习过VB、C++、Java、Android、PHP,而一开始自己写代码的时候,我只是觉得自己怎么舒服怎么去写,功能可以完成不出BUG就好啦,从来没有阅读过编码规范相关的文档。后来因接触了一位大牛,而且是女攻城狮,她指导了我很多,也让我的编码习惯改变了很多。
一、关于Java
一般我使用的是IDEA,而阿里正好有相关的扫描插件,插件支持了IDEA、Eclipse,在扫描代码后,将不符合规约的代码显示出来,甚至在 IDEA 上,还基于 Inspection 机制提供了实时检测功能,编写代码的同时也能快速发现问题所在,还实现了批量一键修复的功能。
相关介绍文章:《阿里巴巴Java开发规约》插件全球首发!
相关插件GitHub:GitHub - alibaba/p3c
IDEA下如何安装使用
打开 IDEA,选择 File -> Settings -> Plugins 直接在搜索栏搜索“Alibaba”
重启IDEA,开始使用。安装后,会提示你重启 IDEA 已启用插件,重启后就可以在你的项目上疯狂点击右键了,当然菜单栏也会出现俩按钮,它有个快捷键Ctrl+Shift+Alt+J
扫描代码后,将不符合规约的代码按 Blocker/Critical/Major 三个等级显示在下方,双击可以定位至代码处,右侧窗口还有针对代码的批量修复功能。
解释下Blocker/Critical/Major三个等级,在 Snoar 中对代码规则有五个级别,这是前三个:崩溃/严重/重要 ,也就是说前两级别是必须要处理掉的。
Eclipse如何安装使用
Eclipse 版插件支持4.2(Juno,JDK1.8+)及以上版本,我们提供自主的Update Site,通过 Help >> Install New Software 然后输入https://p3c.alibaba.com/plugin/eclipse/update 即可看到安装列表。大家可以通过 Help >> Check for Udates 进行插件新版检测
二、关于PHP
PHP的话应该遵循一个已知的标准来编写PHP代码。按照PRS规范执行:
然后我们要先安装phpcs,使用composer全局安装phpcs
composer global require "squizlabs/php_codesniffer="
在windows系统,全局安装的话会在C:\Users\{user name}\AppData\Roaming\Composer\vendor\bin下生成一个phpcs.bat文件,这个是phpstorm后续设置需要用到的文件
File -> Default Setting -> Languages & Frameworks -> PHP -> Code Sniffer -> ... -> 添加phpcs路径 -> Apply
File -> Default Setting -> Editor -> Inspections -> PHP -> PHP Code Sniffer validation (打上勾)-> Coding standard -> PSR2 -> Apply
File -> Default Setting -> Editor -> Inspections -> PHP -> PHP Mess Detector validation (打上勾)-> Options(选择相应规则) -> Apply