阅读时间: 三 分钟
改进代码的最佳方法之一是坚持一套良好的标准。遵循编码标准将使您的代码更容易被他人理解和贡献。
WordPress编码标准
如果你无论如何都要为WordPress做贡献,无论是开发主题、插件还是核心功能,你都需要遵循WordPress编码标准.
该规范涵盖了单引号与双引号、缩进、空格、,尤达条件,等等。
你完全可以熟悉手册在你成长的过程中,试着记住规则。您还可以在VisualStudio代码中设置PHP代码嗅探器,以便在编写代码时检查代码。
在Visual Studio代码中设置PHP代码嗅探
注意:本指南用于在Mac上设置PHP代码嗅探。
首先要做的是通过brew安装php-code-snifer包。如果你已经有了已安装brew打开终端并运行brew安装php-code-niffer
.
在Visual Studio代码中设置PHP验证
接下来,您需要在VisualStudio代码中设置PHP验证。首先,您需要获取PHP在您的机器上执行的路径。运行哪个php
并复制命令输出的路径。应该是这样的/usr/bin/php
.
有了这一点,我们需要在VisualStudio代码中调整PHP设置。在Visual Studio代码中选择代码>首选项>设置。您需要检查以下设置:
- PHP>建议:基本应进行检查。
- PHP>验证:启用应进行检查
- PHP>验证:运行随你。我更喜欢onSave(保存)所以它不是在我打字的整个过程中运行的。但如果您喜欢后者,请将其设置为on类型.
- 最后一个设置是PHP>验证:可执行路径。要设置此项,您需要单击在settings.json中编辑。在您的settings.json中,您将设置
“php.validate.executablePath”:“/usr/bin/php”,
值以匹配您的跑步路径哪个php
早期的。
当您在settings.json中完成了所有的说和做之后,您应该有以下几项。
“php.suggest.basic”:true,“php.validate.executablePath”:“/usr/bin/php”,“php.validate.run”:“onSave”,
向Visual Studio代码中添加PHP CodeSniffer
您需要赋予VisualStudio代码嗅探PHP代码的能力。为此,您需要安装phpcs扩展。您可以从市场或在Visual Studio代码中执行此操作。我喜欢Ioannis Kappas,所以这就是它的基础。
我们将在一分钟内继续配置代码嗅探器。
定义WordPress编码标准
首先,我们需要下载WordPress编码标准来自Github。如果您正在使用_秒对于主题开发,您也需要PHPC兼容性。因为它的配置同时利用了这两者。
您需要克隆WordPress编码标准和PHP兼容性来自Github。请记下您安装它们的路径,因为配置需要该路径。我喜欢将它们存储在我的/站点
目录。
设置代码嗅探的路径
我上面提到的那些路径,您将在这里使用它们。您需要配置phpc以了解在何处查找
危险!在设置代码嗅探的路径之前,请确保打开终端并运行phpcs—配置显示
。这会给你类似的东西installed_paths:/path/to/WordPress-Coding-Standards,/path/to/PHP兼容性
。仅当您已经设置了任何installed_paths时。我现在提出这个问题的原因是,下一个命令将覆盖所有设置的内容。因此,如果您已经有了一些设置,请确保也复制这些路径。
一旦您拥有WordPress Coding Standards和PHPCompatibility repo的所有路径以及已在安装路径命令中设置的任何路径,您就可以使用phpcs—config-set installed_paths/path/to/WordPress-Coding-Standards,/path.to/PHP兼容性
.
警告:⚠️ installed_paths命令将覆盖以前设置的所有installed_paths。如果您之前已经为其他外部标准设置了installed_paths,请首先运行phpcs–config-show,然后运行installed_paths命令,其中包含所有需要用逗号分隔的路径,即:
phpcs—配置集installed_paths/path/1、/path/2和/path/3
在Visual Studio代码中配置phpc
现在,我们系统中的phpc知道在哪里可以找到我们的编码标准规则集,我们需要在VisualStudio代码中进行配置。
在设置之前,我们需要获得系统中phpc的路径。这可以通过跑步来实现哪些phpc
.
直接在settings.json中为这个位配置东西是最简单的代码>首选项>设置然后单击{}图标VS Code将打开settings.json。
在settings.json中,您需要在settings.json中设置以下值。
“phpcs.enable”:true,“phpcs.executablePath”:“/usr/local/bin/phpcs”,“phpcs.standard”:“WordPress”
我们启用phpc并设置标准规则集以使用WordPress。然后我们将从我们的哪些phpc
命令。
让我们把它分解一下。