编码标准

编辑该页面

警告:你浏览的文档欧宝体育电话欧宝娱乐app下载地址Symfony 4.0,不再维护。

读这个页面的更新版本Symf欧宝娱乐app下载地址ony 6.2(当前的稳定版本)。

让你的代码遵循编码标准
欧宝娱乐app下载地址Symfony详细编码标准

编码标准

欧宝娱乐app下载地址Symfony的代码是由成千上万的世界各地的开发人员。让每段代码看起来和感觉熟悉,Symfony定义了一些编码标准必须遵循所有的贡献。欧宝娱乐app下载地址

基于这些Sy欧宝娱乐app下载地址mfony的编码标准PSR-1,PSR-2和PSR-4标准,所以你可能已经知道他们中的大多数。

让你的代码遵循编码标准

代替手动审查代码,Symfony使它简单的代码,以确保你的贡献匹配预期的语法。欧宝娱乐app下载地址首先,安装PHP CS工工具然后,运行这个命令来解决任何问题:

               1 2
               美元cd你的项目/美元php php-cs-fixer。phar修复- v
              

如果你忘了运行这个命令,使拉请求与任何语法问题,我们的自动化工具将提醒你,并提供解决方案。

欧宝娱乐app下载地址Symfony详细编码标准

如果你想详细了解Symfony编码标准,这里有一个简短的例子包欧宝娱乐app下载地址含大多数特性描述如下:

               1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17日18 19 20 21日22日23日24日25日26日27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103
               < ? php/ * *这个文件是Symfony包的一部分。欧宝娱乐app下载地址* * (c)法效力<法比安@欧宝娱乐app下载地址symfonycom > * *完整的版权和许可信息,请查看许可*文件分发源代码。* /名称空间Acme;/ * * *编码标准示范。* /类FooBar{常量SOME_CONST =42;/ * * *@var字符串* /私人美元fooBar;/ * * *@param字符串假美元一些参数描述* /公共函数__construct(美元假){美元这- >fooBar =美元这- >transformText (美元假);}/ * * *@return字符串* *@deprecated* /公共函数someDeprecatedMethod(){@trigger_error (sprintf (% s()方法是弃用自版本2.8和3.0将被删除。使用Acme \记者::someMethod ()。”,__METHOD__),E_USER_DEPRECATED);返回巴兹::someMethod ();}/ * * *转换输入作为第一个参数。* *@parambool | *字符串假美元一些参数描述@param数组中选择一个选项的集合使用美元转换* *@return字符串|零转换输入* *@throws\ RuntimeException当一个无效的选择* /提供私人函数transformText(美元假数组,美元选项=数组()){美元defaultOptions=数组(“some_default”= >“值”,“another_default”= >“更多的价值观”,);foreach(美元选项作为美元选项){如果(! in_array (美元选项,美元defaultOptions)){扔新\ RuntimeException (sprintf (未识别的选项“% s”的,美元选项));}}美元mergedOptions= array_merge (美元defaultOptions,美元选项);如果(真正的= = =美元假){返回零;}如果(“字符串”= = =美元假){如果(“值”= = =美元mergedOptions(“some_default”){返回substr (美元假,0,5);}返回函数美元假);}}/ * * *执行一些基本的检查对于一个给定的值。* *@param混合一些值检查*美元价值@parambool美元theSwitch一些开关来控制方法的流* *@returnbool |真空合成检查如果theSwitch美元不假,否则void * /私人函数reverseBoolean(美元价值=零,美元theSwitch= false){如果(!美元theSwitch){返回;}返回!美元价值;}}
              

结构

每个逗号分隔符后添加一个空格;
添加一个空间二元操作符(= =,& &…),除了连接(。)操作符;
一元操作符(!,- - -附近,…)变量的影响;
总是使用相同的比较除非你需要类型的;
使用尤达条件当检查一个变量与表达式,以避免意外在条件语句(这适用于作业= =,! =,= = =,= = !);
添加一个逗号在多行数组,每个数组项后即使最后一个;
添加一个空白行返回语句,除非仅返回语句组内(如一个如果声明);
使用返回null;当一个函数显式地返回零值和使用返回;当函数返回无效值;
使用括号来表示控制结构身体无论它包含的语句数;
每个文件定义一个类,这并不适用于私人助手类不打算从外部被实例化,因此并不担心PSR-0和PSR-4自动装载标准;
声明类的继承和实现接口类名在同一行;
声明类属性之前方法;
首先声明公共方法,然后最后私营企业的保护。这条规则的例外是类构造函数和设置()和tearDown ()PHPUnit)测试方法,必须始终是第一个方法来增加可读性;
申报同一条直线上的所有参数的方法/函数名,无论有多少参数;
使用括号在实例化类时不管参数构造函数的数量;
异常和错误信息字符串的连接必须使用sprintf;
调用trigger_error型E_USER_DEPRECATED必须切换选择通过吗@操作符。阅读更多约定;
不要使用其他的,elseif,打破后如果和情况下条件返回或扔东西;
不要使用空格(抵消访问器和前]抵消访问器;
添加一个使用声明为每一个类,它不是全局命名空间的一部分。

命名约定

使用camelCase,而不是强调,变量,函数和方法名、参数;
使用下划线的配置选项和参数;
对所有类使用名称空间;
前缀的所有抽象类文摘除了PHPUnit)* TestCase。请注意一些早期Symfony类不遵守本公约和没欧宝娱乐app下载地址有被重命名原因向后兼容性。然而所有的新抽象类必须遵循此命名约定;
后缀接口与接口;
后缀特征与特征;
后缀异常与异常;
对文件名使用字母数字字符和下划线;
在PHPDocs类型提示和铸造、使用bool(而不是布尔或布尔),int(而不是整数),浮动(而不是双或真正的);
别忘了看更详细的约定文档更多主观命名注意事项。

服务命名约定

服务名称必须一样的完全限定类名(FQCN)的类(例如App \ EventSubscriber \ UserSubscriber);
如果有多个服务相同的类,使用FQCN主要服务并使用小写和强调的服务名称。选择把他们组用点(如分离。something.service_name,fos_user.something.service_name);
使用小写字母参数名称(除了指的环境变量% env (VARIABLE_NAME) %语法);
为公共服务(如别名添加类的别名欧宝娱乐app下载地址Symfony \组件\ \类名来something.service_name)。

欧宝体育电话

添加PHPDoc块所有类、方法和功能(虽然你可能会被要求删除PHPDoc不添加值);
相同类型的注释注释分组,以便立即互相关注,和不同类型的注释是由一个空行;
省略了@return标记如果方法不返回任何值;
的@package和@subpackage注释不习惯;
不内联PHPDoc块,即使他们仅仅包含一个标记(如不放/ * * {@inheritdoc} * /在一行);
当添加一个新的类或对现有类作了重大的改变,一个@author标记与个人联系信息可以添加,或扩大。请注意它是可能的个人联系信息更新或删除每个请求医生:“核心团队/ core_team > < /贡献代码的。