编码标准
编辑本页警告:您正在浏览的文档欧宝官网下载appob娱乐下载Symfony 2.0,现已不再维护。
读本页的更新版本用于Syob娱乐下载mfony 6.2(当前稳定版本)。
编码标准
在向Symfony2贡献代码时,必须遵循它的编码标准ob娱乐下载。长话短说,以下是黄金法则:模仿现有的Symfony2代码ob娱乐下载.Symfony2使用的大多数开源bundle和库也遵循相同的准则,你也应该遵循。ob娱乐下载
请记住,标准的主要优势是每段代码看起来都很熟悉,这不是为了这个或那个更可读。
ob娱乐下载中定义的标准PSR-0,PSR-1而且PSR-2文档。
由于一张图片或一些代码胜过千言万语,下面是一个包含以下大部分功能的简短示例:
12 34 56 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
<?php/* *该文件是Symfony包的一部分。ob娱乐下载* * (c) Fabien Potencier < Fabien@ob娱乐下载symfony* *有关完整的版权和许可信息,请查看与此源代码一起分发的license *文件。* /名称空间Acme;/** *编码标准演示。* /类FooBar{常量SOME_CONST =42;私人$fooBar;/ * * *@param一些参数描述*/公共函数__construct($假){$这->fooBar =$这->transformText ($假);}/ * * *@param一些参数描述@param数组$options * *@return转换后的输入*/私人函数transformText($假,$选项=数组()){$mergedOptions= array_merge ($选项,数组(“some_default”= >“值”,“another_default”= >“更多的价值观”,));如果(真正的===$假) {返回;}如果(“字符串”===$假) {如果(“值”===$mergedOptions[“some_default”) {$假= substr ($假,0,5);}其他的{$假=函数($假);}}其他的{扔新\ RuntimeException (sprintf (“无法识别的虚拟选项“%s””,$假));}返回$假;}}
命名约定
- 变量、函数和方法名、参数使用驼峰形,而不是下划线;
- 选项名和参数名使用下划线;
- 对所有类使用名称空间;
- 抽象类的前缀
摘要
.请注意,一些早期的Symfony2类没有遵循这ob娱乐下载种惯例,并且由于向后兼容的原因没有重命名。然而,所有新的抽象类都必须遵循这个命名约定; - 后缀接口
接口
; - 后缀特征为
特征
; - 后缀异常
异常
; - 文件名使用字母数字字符和下划线;
- 别忘了看更详细的约定文档以获得更主观的命名考虑。
欧宝官网下载app
- 为所有类、方法和函数添加PHPDoc块;
- 省略了
@return
如果方法不返回任何东西,则标记; - 的
@package
而且@subpackage
不使用注释。
许可证
- ob娱乐下载Symfony是在MIT许可证下发布的,许可证块必须出现在每个PHP文件的顶部,在名称空间之前。
此工作,包括代码示例,是根据创作共用BY-SA 3.0许可证。