PHP 编码规范 3.1 开头注释
2013-04-14 09:11
357 查看
3.1 开头注释
所有的源文件都应该在开头有一个C语言风格的注释，其中列出类名、功能、版本信息、日期、作者和版权声明：
/*
* 类名
* 功能
* 版本
* 日期
* 作者
* 版权
*/
如果对文件进行了修改，应该在文件头中说明修改目的、修改日期、修改人，并变更文件的版本信息；如果修改问文件的一部分，则在文件中进行注释即可，并且标识出修改部分的起止位置
……
/*
* 修改目的
* 修改日期
* 修改人
* 版本
*/
……
修改起始
……
……
修改结束
……
所有的源文件都应该在开头有一个C语言风格的注释，其中列出类名、功能、版本信息、日期、作者和版权声明：
/*
* 类名
* 功能
* 版本
* 日期
* 作者
* 版权
*/
如果对文件进行了修改，应该在文件头中说明修改目的、修改日期、修改人，并变更文件的版本信息；如果修改问文件的一部分，则在文件中进行注释即可，并且标识出修改部分的起止位置
……
/*
* 修改目的
* 修改日期
* 修改人
* 版本
*/
……
修改起始
……
……
修改结束
……
内容来自用户分享和网络整理，不保证内容的准确性，如有侵权内容，可联系管理员处理 
相关文章推荐
- PHP 编码规范 4.5 文档注释
- 理解学习PHP编码规范之注释和文件结构
- PHP编码规范之注释和文件结构说明
- PHP 编码规范 4.1 块注释
- PHP 编码规范 4.3 尾端注释
- PHP编码规范之注释和文件结构说明
- Zend Framework的PHP编码规范【1】
- PHP 编码规范 4.4 行末注释
- PHP编码规范之PSR-2
- 3.7 代码注释和编码规范
- PHP 编码规范6
- PHP编码规范说明
- PHP编码规范(PSR-1)-基本代码规范
- PHP编码规范_新手必读_程序员的自我修养
- php web开发的编码规范
- php 编码规范
- php编码规范
- PHP编码规范与PSR标准
- eclipse和myeclips自动生成编码规范注释(xml导入)
- 使用 PHP_CodeSniffer 检查 代码 是否 符合 编码规范