Symfony 编码规则 Coding Standards

Coding Standards

http://symfony.com/doc/current/contributing/code/standards.html

结构

  • 永远都不要用短标签(<?)
  • 类文件不要用通常的 ?> 符号结尾;
  • 缩进是4个空格(但是不允许使用制表符);
  • 使用换行符(0X0A)结束每一行;
  • 在每个都好后面加一个空格;
  • 不要在左括号后面或者右括号前加空格;
  • 在操作符(==, &&, …)前后要加一个空格;
  • 控制关键字(if, else, for, while, …)的左括号前要加一个空格;
  • return语句前要加一个空行,除非在这个语句块(如if语句)中只有return语句;
  • 在每一行的末尾不要尾随空格;
  • 无论控制结构体包含多少语句都用大括号来表示;
  • 在类、方法、函数的声明中用到括号应该放在当前行中;
  • 将条件语句(if, else, …)与左括号用空格而不是空行隔开;
  • 明确的声明类、方法和属性的访问权限(不允许使用var);
  • 使用PHP本地类型常量:true, false, null时,使用小写,array()也是一样的;
  • 对于用下划线划分字符的常量,大写;
  • 一个文件中定义一个类;
  • 在声明类方法前声明类属性;
  • 首先声明public方法,然后是protected方法,最后是private方法。

命名约定

  • 对于变量、函数、方法的命名使用驼峰命名法,而不是下划线命名法;
  • 对于选项、自变量和参数名称的命名使用下划线命名法;
  • 对于所有类使用namspaces;
  • 接口的后缀用Interface;
  • 文件名使用数字、字符、下划线;
  • 不要忘了从更详细的规约文档查看更主观的命名注意事项。

文档

  • 为所有类、方法、函数增加PHPDoc块;
  • 如果函数不返回任何东西,忽略@return标签;
  • 不能使用@package and @subpackage注释。

许可信息

  • Symfony是在MIT许可下发布的,在每一个PHP文件开头,在namaspaces之前都应该添加许可信息部分。

About 智足者富

http://chenpeng.info

发表评论

电子邮件地址不会被公开。 必填项已用*标注

您可以使用这些HTML标签和属性:

<a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code> <del datetime=""> <em> <i> <q cite=""> <s> <strike> <strong>