良好的编码标准在任何软件开发项目中都非常重要。当一个庞大、多元化且遍布全球的开发者社区为某个项目做出贡献时,这些标准就显得更加重要。优秀软件与卓越软件的区别之一,不仅在于其功能或实际执行的功能,还在于其源代码的质量。

为了在竞争激烈的开源和专有软件行业中立足,源代码不仅需要设计精美,还需要外观简洁优雅。Joomla 编码标准手册旨在帮助确保我们的代码达到最高质量,使其易于阅读、调试和维护。

指导原则

由于可读性强的代码更易于维护,因此,指导我们实现这一目标的指南是一套针对 Joomla 软件项目中使用的不同软件语言的精心设计的编码标准。Joomla 拥有悠久的传统,致力于通过出色的代码来支持出色的产品。

本手册汇集了项目过去和现在贡献者的集体智慧,形成了 Joomla 编码的权威标准,无论是在核心 Joomla 框架中还是在构成 Joomla CMS 堆栈一部分的扩展中。本手册也充当了 Joomla 开发者社区的灯塔,安全地引导开发者避开在编写整洁、优美的代码方面变得松懈的陷阱。

Joomla 编码标准大量借鉴了 PEAR 针对 PHP 文件的编码标准,并在必要时进行了补充和调整。

有一些 工具可用,可以帮助您的代码符合我们的标准。

贡献到本手册

如果您想为本手册做出贡献并进行改进,可以在 https://github.com/joomla/coding-standards/tree/master/manual 找到源文件。