小猿认为PHP编码规范的作用就是当一个项目团队人员超过2人时,大家遵守一个一致的标准,能过让参与项目的工程师更容易了解项目中的代码、弄清程序的状况,以便于新的程序猿很快的适应环境,避免一套代码中存在多种风格,致使其它人在阅读时浪费过多的时间和精力,并且更重要的是在遵循一致的编码规范前提下,能够有效降低编码出错的概率。
这里我们来说一说PHP编码规范中的代码注释,每一位PHPer都知道,PHP代码的注释有两种:
1)单行注释:在语句结尾用双反斜杠”//“注释
2)多行注释:多行注视以”/*”或“/**”符号开头,以”*/“符号作为注释结束符,如果是需要生成文档的注释则必须是以“/**”开头,以“*/”结尾。
需要注释的代码往往有文件注释、类注释、方法注释、属性注释等。
第一、文件注释
/**
*(简述,用在索引列表中)
*详细的功能描述(可有可无)
*
copyrightCopyright,公司名或作者名*
author{AUTHOR}*
versionId:{FILE_NAME},v{VERSION}{TIME}{AUTHOR}Exp*/
第二、类注释
/**
*(概要)
*详细的功能描述
*
property类型prop属性描述*
author{AUTHOR}*
packageapplication.