php 注释函数参数样例,PHP函数注释规范

码农一般都处于频繁Coding中，回过头再看自己2月前写的函数，估计也头大。。。因此，在此分享一些常用的函数注释标签及说明，建议大家尽量用吧！

/**

* @name 名字

* @abstract 申明变量/类/方法

* @access 指明这个变量、类、函数/方法的存取权限

* @author 函数作者的名字和邮箱地址

* @category 组织packages

* @copyright 指明版权信息

* @const 指明常量

* @deprecate 指明不推荐或者是废弃的信息MyEclipse编码设置

* @example 示例

* @exclude 指明当前的注释将不进行分析，不出现在文挡中

* @final 指明这是一个最终的类、方法、属性，禁止派生、修改。

* @global 指明在此函数中引用的全局变量

* @include 指明包含的文件的信息

* @link 定义在线连接

* @module 定义归属的模块信息

* @modulegroup 定义归属的模块组

* @package 定义归属的包的信息

* @param 定义函数或者方法的参数信息

* @return 定义函数或者方法的返回信息

* @see 定义需要参考的函数、变量，并加入相应的超级连接。

* @since 指明该api函数或者方法是从哪个版本开始引入的

* @static 指明变量、类、函数是静态的。

* @throws 指明此函数可能抛出的错误异常,极其发生的情况

* @todo 指明应该改进或没有实现的地方

* @var 定义说明变量/属性。

* @version 定义版本信息

**/

function xxxx( $a ){

...

}

php 注释函数参数样例,PHP函数注释规范 - YangJunwei相关推荐

C++ 笔记（13）— 函数（函数声明、函数定义、函数调用[传值、指针、引用]、函数参数默认值、函数重载）
每个 C++ 程序都至少有一个函数,即主函数 main() ,所有简单的程序都可以定义其他额外的函数. 1. 函数声明函数声明告诉编译器函数的名称.返回类型和参数.函数声明包括以下几个部分: ret ...
习题 9.5 建立一个对象数组，内放5个学生的数据（学号、成绩），设立一个函数max，用指向对象的指针作函数参数，在max函数中找出5个学生中成绩最高者，并输出其学号。
C++程序设计(第三版) 谭浩强习题9.5 个人设计习题 9.5 建立一个对象数组,内放5个学生的数据(学号.成绩),设立一个函数max,用指向对象的指针作函数参数,在max函数中找出5个学生中成 ...
go 函数参数nil_go内置函数make
go内置函数make主要用于创建map, slice, chan等数据结构.下面简要分析下编译器对于make的处理过程. 一内置函数的定义 universe.go源文件定义了go内置函数列表,Mai ...
python函数参数定义顺序_Python函数定义-位置参数-返回值
原标题:Python函数定义-位置参数-返回值 1 函数介绍函数在编程语言中就是完成特定功能的一个词句组(代码块),这组语句可以作为一个单位使用,并且给它取一个名字.可以通过函数名在程序的不同地方多 ...
【Groovy】Groovy 方法调用 ( Java 中函数参数是接口类型 | 函数参数是接口类型可以直接传递闭包 )
文章目录一.Java 中函数参数是接口类型二.函数参数是接口类型可以直接传递闭包三.完整代码示例一.Java 中函数参数是接口类型在 Android 中经常使用如下形式的接口 : 定义一 ...
“引用作为函数参数”与 “引用作为函数返回值”
一.引用作为函数参数作为函数参数时引用有两种原因: 1.在函数内部会对此参数进行修改:2.提高函数调用和运行效率. 关于第一点,都知道C++里提到函数就会提到形参和实参.如果函数的参数实质就是形参, ...
python函数参数为列表_python函数中把列表(list)当参数时的入坑与出坑
在Python函数中,传递的参数如果默认有一个为列表(list),那么就要注意了,此处有坑. 入坑挖坑 def f(x,li=[]): for i in range(x): li.append(i ...
java调用js匿名函数参数,js中匿名函数和回调函数
匿名函数: 通过这种方式定义的函数:(没有名字的函数) 作用:当它不被赋值给变量单独使用的时候 1.将匿名函数作为参数传递给其他函数 2.定义某个匿名函数来执行某些一次性任务 var f = func ...
C语言函数指针做函数参数（即回调函数）
文章目录函数指针做函数参数(回调函数) 回调函数概念一般有三种调用方式回调函数的作用回调函数调用时刻回调函数的语法: 1.简单的函数类型为:无参数.无返回值的函数. 2.完全形式的回调函数 ...

php 注释函数参数样例,PHP函数注释规范 - YangJunwei

php 注释函数参数样例,PHP函数注释规范 - YangJunwei相关推荐

最新文章

热门文章