编码风格指南
从 Joomla 4.2 版本开始,Joomla 使用 PSR-12 编码标准。您可以在 IDE 中启用此编码标准,并在不遵循编码标准的情况下获得提示,也可以使用自动修复功能。我们建议您在开发自己的扩展时遵循此标准,以保持与核心代码的兼容性,并确保您的代码有望在未来版本中正常工作。
安装代码风格检查器
待办事项
从 https://docs.joomla.org/Joomla_CodeSniffer 复制并更新到新版本
使用集成检查器
如果您从 GitHub 下载 Joomla 的完整开发人员版本(而不是可下载的安装压缩包),您将找到一个名为“代码嗅探器”的工具,用于检查编码标准违规,以及一个名为“代码修复器”的工具,用于修复大部分(但有时并非所有)违规。
要运行代码嗅探器/修复器,您需要启动终端,导航到您的 Joomla 根目录(安装 Joomla 的目录)并运行以下命令之一(不要忘记“.”)
检查代码风格违规
./libraries/vendor/bin/phpcs --extensions=php -p --standard=ruleset.xml .
这将针对整个 Joomla! 安装运行代码风格检查,包括您的扩展(如果已安装在 Joomla! 中)。
修复代码风格违规
./libraries/vendor/bin/phpcbf --extensions=php -p --standard=ruleset.xml .
这将针对整个 Joomla! 安装运行代码风格修复器,包括您的扩展。修复器会尝试修复所有违规,但有时无法修复所有违规。因此,建议您之后运行检查器(见上文)并手动修复剩余的问题。
待办事项
此页面尚未完成,请使用此页面底部的“编辑此页面”链接来帮助使其更有用。