编码标准
编辑该页面警告:你浏览的文档欧宝官网下载appob娱乐下载Symfony 2.5,不再维护。
读这个页面的更新版本Symfob娱乐下载ony 6.2(当前的稳定版本)。
编码标准
Symfony贡献代码时,你必须遵循它的编码标准。ob娱乐下载长话短说,这里是黄金法则:模仿现有的Symfony的代码ob娱乐下载。大多数开源包和库使用Symfony还遵循相同的规定,你也应该这么做。ob娱乐下载
记住,标准的主要优势是,每段代码看起来和感觉熟悉,这不是关于这个或那个更具可读性。
ob娱乐下载Symfony中定义的标准PSR-0,PSR-1和PSR-2文档。
因为一张照片或者一些代码值得一千字,下面是一个简短的示例包含大多数特性描述如下:
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
< ? php/ * *这个文件是Symfony包的一部分。ob娱乐下载* * (c)法效力<法比安@ob娱乐下载symfonycom > * *完整的版权和许可信息,请查看许可*文件分发源代码。* /名称空间Acme;/ * * *编码标准示范。* /类FooBar{常量SOME_CONST =42;私人美元fooBar;/ * * *@param字符串假美元一些参数描述* /公共函数__construct(美元假){美元这- >fooBar =美元这- >transformText (美元假);}/ * * *@param字符串$ *虚拟一些参数描述@param数组$ * *选项@return字符串|零转换输入* *@throws\ RuntimeException * /私人函数transformText(美元假数组,美元选项=数组()){美元mergedOptions= array_merge (数组(“some_default”= >“值”,“another_default”= >“更多的价值观”),美元选项);如果(真正的= = =美元假){返回;}如果(“字符串”= = =美元假){如果(“值”= = =美元mergedOptions(“some_default”){返回substr (美元假,0,5);}返回函数美元假);}扔新\ RuntimeException (sprintf (“识别假选项“% s”,美元假));}私人函数reverseBoolean(美元价值=零,美元theSwitch= false){如果(!美元theSwitch){返回;}返回!美元价值;}}结构
- 每个逗号分隔符后添加一个空格;
- 添加一个空间二元操作符(
= =,& &…),除了连接(。)操作符; - 一元操作符(
!,- - -附近,…)变量的影响; - 添加一个逗号在多行数组,每个数组项后即使最后一个;
- 添加一个空白行
返回语句,除非仅返回语句组内(如一个如果声明); - 使用括号来表示控制结构身体无论它包含的语句数;
- 每个文件定义一个类,这并不适用于私人助手类不打算从外部被实例化,因此并不担心PSR-0标准;
- 声明类属性之前方法;
- 首先声明公共方法,然后最后私营企业的保护。这条规则的例外是类构造函数和
设置和拆卸PHPUnit)测试方法,应该是第一个方法来增加可读性; - 使用括号在实例化类时不管参数构造函数的数量;
- 异常消息字符串应该连接使用sprintf。
命名约定
- 使用camelCase,而不是强调,变量,函数和方法名、参数;
- 使用下划线的选项名称和参数名称;
- 对所有类使用名称空间;
- 抽象类前面加上
文摘。请注意一些早期Symfony类不遵守本公约和没ob娱乐下载有被重命名原因向后兼容性。然而所有的新抽象类必须遵循此命名约定; - 后缀接口与
接口; - 后缀特征与
特征; - 后缀异常与
异常; - 对文件名使用字母数字字符和下划线;
- 在PHPDocs类型提示和铸造、使用
bool(而不是布尔或布尔),int(而不是整数),浮动(而不是双或真正的); - 别忘了看更详细的约定文档更多主观命名注意事项。
服务命名约定
- 一个服务名称包含组织、由点;
- 包的DI别名是第一组(如。
fos_user); - 对服务和参数名称使用小写字母;
- 一组使用下划线符号名称;
- 每个服务都有一个相应的参数包含类名称,后
服务NAME.class公约。
欧宝官网下载app
- 添加PHPDoc块所有类、方法和功能;
- 省略了
@return标记如果方法不返回任何值; - 的
@package和@subpackage注释不习惯。
许可证
- ob娱乐下载Symfony是MIT许可下发布,许可块必须出席每一个PHP文件,之前的名称空间。
这项工作,包括代码示例,许可下Creative Commons冲锋队3.0许可证。
