Jetbrains PhpStorm 注释 + PSR-12代码检测 + 格式化代码

阅读量: 24

注释

一、常见需要注释的区域

• 常量名
• 属性名
• 变量名
• 函数名
• 类名

二、快速注释的手段

1. 函数快速注释

• 在编码过程中，没有参数的函数通过快捷键/**加回车，我们只要补充函数描述信息即可

• 在编码过程中，有参数的函数并且有响应数据类型，通过快捷键/**加回车，我们只要补充函数描述信息、参数注释即可

2. 属性快速注释

在编码过程中，通过快捷键/**加回车，并对属性的类型做上标注

三、注释模板设置

1. 开发者基础信息模板设置

• 开发者名字/座右铭
• 联系邮箱
• 开发者名字加联系邮箱的组合

2. 引用设置

• PHP File Header（PHP文件头注释）
• PHP Function Doc Comment（PHP函数文档注释）
• PHP Interface Doc Comment（PHP接口文档注释）
• PHP Property Doc Comment（PHP属性文档注释）
• PHP Trait Doc Comment（PHP复用方法文档注释）

3. 关联文件设置

• PHP File
• PHP Class
• PHP Interface
• PHP Trait

PSR-12 代码检测

1. PSR-12介绍

PSR 是 PHP Standard Recommendation 的简写，即PHP推荐标准。PSR 不是PHP官方标准，而是从如Zend、Symfony2等知名PHP项目中提炼出来的一系列标准。

此 PSR-12 是 PSR-2 的延伸，因此也是 PSR-1 的延伸。 PSR-12 的基础是 PSR-2，因此下面会提供了一系列差异来帮助进行移植，但它应该被视为一个独立的规范。

格式化代码

格式化代码是按个人亦或者团队在进行项目开发时而设置的，主要是减少人为误编码的问题，及提高团队开发代码整洁的一种工作手段。

常见的开发编辑器进行代码格式化都需要人为触发快捷键，比如在PhpStorm中代码的格式化就需要通过Ctrl + L快捷键进行格式化。

以下是我推荐使用的格式化代码的方案：

1. 录制宏键格式化代码

常见的电脑端软件，进行数据保存时，快捷键大多数都是Ctrl + S，那在编码的过程中可以把这个快捷键动作进行拆分，变为（格式化代码、保存代码），其录制宏键的方式如下：​​

code -style.xml下载

配置分享

下载压缩文件后解压导入code -style.xml文件至PhpStorm