编码标准
编辑该页面警告:你浏览的文档欧宝体育电话欧宝娱乐app下载地址Symfony 2.0,不再维护。
读这个页面的更新版本Symf欧宝娱乐app下载地址ony 6.2(当前的稳定版本)。
编码标准
贡献代码Symfony2时,你必须遵循它的编码标准。欧宝娱乐app下载地址长话短说,这里是黄金法则:模仿现有Symfony2代码欧宝娱乐app下载地址。大多数开源包和库使用Symfony2还遵循相同的规定,你也应该这么做。欧宝娱乐app下载地址
记住,标准的主要优势是,每段代码看起来和感觉熟悉,这不是关于这个或那个更具可读性。
欧宝娱乐app下载地址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
< ? php/ * *这个文件是Symfony包的一部分。欧宝娱乐app下载地址* * (c)法效力<法比安@欧宝娱乐app下载地址symfonycom > * *完整的版权和许可信息,请查看许可*文件分发源代码。* /名称空间Acme;/ * * *编码标准示范。* /类FooBar{常量SOME_CONST =42;私人美元fooBar;/ * * *@param字符串假美元一些参数描述* /公共函数__construct(美元假){美元这- >fooBar =美元这- >transformText (美元假);}/ * * *@param字符串$ *虚拟一些参数描述@param数组$ * *选项@return字符串|零转换输入* /私人函数transformText(美元假,美元选项=数组()){美元mergedOptions= array_merge (美元选项,数组(“some_default”= >“值”,“another_default”= >“更多的价值观”));如果(真正的= = =美元假){返回;}如果(“字符串”= = =美元假){如果(“值”= = =美元mergedOptions(“some_default”){美元假= substr (美元假,0,5);}其他的{美元假=函数(美元假);}}其他的{扔新\ RuntimeException (sprintf (“识别假选项“% s”,美元假));}返回美元假;}}命名约定
- 使用camelCase,而不是强调,变量,函数和方法名、参数;
- 使用下划线的选项名称和参数名称;
- 对所有类使用名称空间;
- 抽象类前面加上
文摘。请注意一些早期Symfony2类不遵守本公约并欧宝娱乐app下载地址没有重命名原因向后兼容性。然而所有的新抽象类必须遵循此命名约定; - 后缀接口与
接口; - 后缀特征与
特征; - 后缀异常与
异常; - 对文件名使用字母数字字符和下划线;
- 别忘了看更详细的约定文档更多主观命名注意事项。
欧宝体育电话
- 添加PHPDoc块所有类、方法和功能;
- 省略了
@return标记如果方法不返回任何值; - 的
@package和@subpackage注释不习惯。
许可证
- 欧宝娱乐app下载地址Symfony是MIT许可下发布,许可块必须出席每一个PHP文件,之前的名称空间。
这项工作,包括代码示例,许可下Creative Commons冲锋队3.0许可证。
