1、PHP文件头注释规范: 1/**2* [description] PHP文件描述3* @author [author] <[email]> 作者信息,[作者名称]<[邮箱地址]>4* @version [version] 当前版本号[版本号]5* @since [version] 从项目哪个版本加入此文件,[版本]6*/ 2、PHP方法(函数)注释规范: 1/**2* [function description] 方法(函数...
*@access指明这个变量、类、函数/方法的存取权限 *@author函数作者的名字和邮箱地址 *@category组织packages *@copyright指明版权信息 *@const指明常量 *@deprecate指明不推荐或者是废弃的信息 *@example示例 *@exclude指明当前的注释将不进行分析,不出现在文挡中 *@final指明这是一个最终的类、方法、属性,禁止派生、...
二、命名规范 1.目录和文件 目录使用小写+下划线 类库,函数文件统一以.php为后缀 类的文件名均以命名空间定义,并且命名空间的路径和类库文件所在路径一致 类文件采用驼峰法命名(首字母大写),其他文件采用小写+下划线命名 类名和类文件名保持一致,统一采用驼峰法(首字母大写) 2.函数和类,属性命名 类的命名采用驼峰...
注释的要归档才有意义,否则,假如在一个地方放一条注释描述你做了什么选择和你为什么这么做,只有考古学家才能发现这是最有用的信息。(如何归档另行规范) 5.3. 注释结构 工程的每部分都有特定的注释结构。 程序中的注释,这里给出示例作为规范,注释中以 * @ 为关键字的开始,以:为注释关键字结尾。 5.3.1. 预定...
文档注释描述php的类、构造器,方法,以及字段(field) 。每个文档注释都会被置于注释定界符/**...*/之中,一个注释对应一个类或成员。 该注释应位于声明之前: /** * 说明这个类的一些 ... */ class Example { ... 注意顶层(top-level)的类是不缩进的,而其成员是缩进的。描述类的文档注释的第一行(/**...
以下是关于PHP注释规范的一些要点,共计1000字。 1.文件注释(File Comments): 在每个PHP文件的开头,应该包含一个文件注释。文件注释应该包含以下信息: -文件的作者 -文件的版本号 -文件的创建日期和最后修改日期 -文件的目的和功能 -文件中包含的类和函数的概述 这样的文件注释可以让其他开发者快速了解文件的基本...
1、有利于提高代码的可读性,毕竟读你的注释要比读你的代码要容易的多! 2、有利于规划自己的代码布局!之所以这么说,是因为和代码注释的种类有关。“有利于代码的布局”,这种看着有点悬的事,光说是说不明白的,我们需要实实在在的例子做支撑! 3、由于我们的注释规范是按照phpdocumentor的要求,所以通过这个工具,还...
方法。这是用在类注释里的标记。特别适合一些动态加载的类,IDE无法自动提示出来,这时就可以通过写@method标记来告诉IDE我这类里有哪些方法 格式@method [返回值类型] [名称]([[类型] [参数]<, ...>]) [<描述>] 例如@method string google(string $question) 向谷歌提问,返回答案内容 ...
PHP 注释规范 PHP 注释规范 注释在写代码的过程中非常重要,好的注释能让你的代码读起来更轻松,在写代码的时候一定要注意注释的规范。 php里面常见的几种注释方式: 1.文件头的注释,介绍文件名,功能以及作者版本号等信息 /*** *** O W E N -- W E B I N T E R N E T T E C H N O L O ...
注释关键字:comment 语法:在数据类型之后comment '注释内容’;注意:注释不分语言类型,都是为了方便别人和自己去维护代码。 唯一键 唯一键是一个索引,对应字段里面的数据应该具有唯一性。 存在:一个表主键也是用来保证数据的唯一性(对应的字段),但是一张表只能拥有一个主键,但是其他字段也有可能需要保证数据唯一性,唯...