本章概述了贡献给 Joomla 项目的 文件的基本指南。 记住为 Joomla 项目编码时最重要的规则是,**如有疑问,请咨询**。

文件格式

贡献给 Joomla 的所有文件必须是

  • 以 ASCII 文本存储
    例外:语言区域设置和一些包含非 ASCII 字符的测试文件
  • 使用 UTF-8 字符编码
  • 遵循以下规则,采用 Unix 格式。
    1. 行必须仅以换行符 (LF) 结尾。
    2. 换行符表示为序数 10、八进制 012 和十六进制 0A。
    3. 不要使用像 Macintosh 计算机那样的回车符 (CR) 或像 Windows 计算机那样的回车符/换行符组合 (CRLF)。

拼写

代码注释和类、函数、变量和常量命名中使用的单词和术语的拼写应一般符合英式英语规则 (en_GB)。 允许一些例外,例如使用符合 PHP API 或其他既定约定的常见编程名称,例如 color,其中保持美式英语拼写是惯例。

缩进

使用制表符来缩进代码(不是 PEAR 标准要求的空格)。 源代码编辑器或集成开发环境 (IDE)(如 Eclipse)必须将缩进的制表符设置为长度为四个 (4) 个空格。

行长

文件中的行长没有最大限制,但是,建议使用大约 150 个字符的理论值,以实现良好的可读性,而无需水平滚动。 如果单个行的代码性质要求更长的行,并且换行会对最终输出产生不利影响(例如,对于混合 PHP/HTML 布局文件),则允许更长的行。