欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  php教程

PHP 编码规范(2)

程序员文章站 2022-06-16 17:11:44
...
3.1 开头注释

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


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

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

……

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

……

修改起始

……

……

修改结束

……