理解学习PHP编码规范之源文件的编码规范

豆豆网   技术应用频道   2007年08月21日  【字号: 收藏本文

内容摘要:PHP编码规范

  开头注释

  所有的源文件都应该在开头有一个C语言风格的注释,其中列出类名、功能、版本信息、日期、作者和版权声明:

/*
  * 类名
  * 功能
  * 版本
  * 日期
  * 作者
  * 版权
  */

  如果对文件进行了修改,应该在文件头中说明修改目的、修改日期、修改人,并变更文件的版本信息;如果修改问文件的一部分,则在文件中进行注释即可,并且标识出修改部分的起止位置

……
/*
  * 修改目的
  * 修改日期
  * 修改人
  * 版本
  */
……

  修改起始

  ……

  ……

  修改结束

  ……

  3.2 引入语句

  引入语句应该位于文件的头部,并在引入时说明引入文件的作用。例如:

//数据库操作类
require( “db.php” );

  3.3 类的声明

  1 类文档注释(/**……*/) 该注释中所需包含的信息,参见"文档注释"

  2 类的声明

  3 类实现的注释(/*……*/)如果有必要的话 该注释应包含任何有关整个类的信息,而这些信息又不适合作为类文档注释。

  4 类的(静态)变量 首先是类的公共变量,随后是保护变量,再后是包一级别的变量(没有访问修饰符,access modifier),最后是私有变量。

  5 实例变量 首先是公共级别的,随后是保护级别的,再后是包一级别的(没有访问修饰符),最后是私有级别的。

  6 构造器

  7 方法 这些方法应该按功能,而非作用域或访问权限,分组。例如,一个私有的类方法可以置于两个公有的实例方法之间。其目的是为了更便于阅读和理解代码

责编:豆豆技术应用

正在加载评论...