类C语言语法风格最大的问题就是用花括号区分代码块,这导致源码排版容易混乱,对于我这种有代码洁癖的人来说非常痛苦,所以我最喜欢的语法风格是Python的,用缩进区分代码块,排版不规范直接判处语法错误。

命名规范

所有命名使用驼峰风格。

源码开头定义命名空间,Flamework框架入口类的命名空间为“org\x3f\flamework”,其余类的命名空间应在此基础上追加与所在目录路径匹配的内容。例如,框架源码目录下一级子目录“base”中的类文件的命名空间均为“org\x3f\flamework\base”。

类名必须是名词,不允许添加任何无意义的前缀或后缀,只允许使用大小写英文字母且首字母大写。

方法名必须是“动词+名词”的形式(如果动词意义明确且不需要宾语,可省略后者),只允许使用大小写英文字母及阿拉伯数字和下划线,首字母小写。

属性名分两种情况,对于存储普通数据的属性,名称必须是名词;对于布尔型属性,名称必须是“动词+名词”的形式。只允许使用大小写英文字母及阿拉伯数字和下划线,首字母小写。

源码文件名必须与类名相同,后缀统一使用“.php”。

注释规范

统一使用phpDocumenter的注释规范。

类注释必须注明@author、@since。

属性和方法的作者如果和类的创建者不同,必须注明@author,此外必须注明@since。

文件格式

所有文本文件统一使用UNIX格式和UTF-8编码。

严禁使用制表符缩进代码,必须使用4个空格替代制表符。

类、属性、方法、方法内部代码块都必须严格按照层级缩进。