来源:http://trac.seagullproject.org/wiki/Standards/CodingStandards

编码标准

Seagull尽可能多地遵循PEAR编码标准,你可以在CODING_STANDARDS.txt这个文件查看我们的编码标准。

下面是编码标准中的一些你可能不想使用的部分:

PHP

  • 所有的变量遵循骆驼命名法(bumpy caps notation),即$thisIsMyVariable而不是$this_is_my_variable
  • 所有类名的首字母为大写且遵循骆驼命名法(bumpy caps).
  • 像Java一样,每一个文件最好只包含一个类且该文件名必须与类名一样
  • 常量以大写形式编写,如果有很多个单词,中间用下划线分开
  • 像'true','null',通常要小写
  • 为了避免PHP发出E_NOTICE错误,必须测试未初始化的变量
  • 基本上与Javadoc一样,大多数的类使用PHP文档注释符注释
  • require_once 和 inclue_once后面无须加圆括号,因为它们不是函数
  • 为了更利于其他人读懂,代码尽可能加注释
  • 不使用php的短标签”<?”,因为这与XML处理不兼容
  • 像Java一样,不论何时描述使用变量名都应尽可能增加可读性,但叙述也不是详细
  • 只有需要php解析字符串内容而导致超支时,才不可避免地使用”双引号”定义方法。
  • &符号通常被用来实例新的对象,但PHP5中将不需要它
  • 一行代码行最好不要超过80个字符

SQL

与PHP编码风格一样,当你设计新的表时,同样也要遵循一些规则:

  • 所有的表&字段全部小写
  • 主键的名称为:tablename_id
  • 不使用MySQL的自动增量(autoincrement),使用PEAR::DB提供的次序(sequences)来代替
  • 实体应当以单数形式,而不是复数,因此使用'book'代替‘books’
  • 表名的关联用下划线分开,例如:user_preference
 
standards/codingstandards.txt · 最后更改: 2010/05/30 00:21 (外部编辑)
 
Except where otherwise noted, content on this wiki is licensed under the following license:GNU Free Documentation License 1.2