php函数和方法的注释（php注释种类有哪些?这些注释在何种场合下使用）

• 1、php怎么查看类方法的自定义文字注释说明
• 2、php中怎样注释掉一部分的代码
• 3、php中如何给类规范的注释
• 4、什么是PHP的函数？

@access

使用范围：class,function,var,define,module

该标记用于指明关键字的存取权限：private、public或proteced

@author

指明作者

@copyright

使用范围：class，function，var，define，module，use

指明版权信息

@deprecated

使用范围：class，function，var，define，module，constent，global，include

指明不用或者废弃的关键字

@example

该标记用于解析一段文件内容，并将他们高亮显示。Phpdoc会试图从该标记给的文件路径中读取文件内容

@const

使用范围：define

用来指明php中define的常量

@final

使用范围：class,function,var

指明关键字是一个最终的类、方法、属性，禁止派生、修改。

@filesource

和example类似，只不过该标记将直接读取当前解析的php文件的内容并显示。

@global

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

1、首先要先建一个php的文件(这里名字叫comment.php，可以随便改)。

2、然后要在文件里面写入PHP运行的基本格式。

3、第一种注释方法:使用双斜杠’//’作为单行注释。

4、第二种注释方法:也是单行注释，是用’#’符号。

5、第三种注释方法:多行注释，是用’/**/’符号，中间可以换行。

6、最后运行看一下效果，这样注释就不会显示在前端页面上了。

需要准备的材料分别是：电脑、phpstrom编辑器。

1、首先，打开phpstrom编辑器，新建php文件，例如：index.php，定义一个函数示例。

2、在function的上方一行，输入：/**，然后按回车。

3、此时会发现phpstrom编辑器将函数的注释自动生成了。

PHP 用户定义函数

除了内建的 PHP 函数，我们可以创建我们自己的函数。

函数是可以在程序中重复使用的语句块。

页面加载时函数不会立即执行。

函数只有在被调用时才会执行。

在 PHP 创建用户定义函数

用户定义的函数声明以关单 “function” 开头：

语法

function functionName() {

被执行的代码;

}

注释：函数名能够以字母或下划线开头（而非数字）。

注释：函数名对大小写不敏感。

提示：函数名应该能够反映函数所执行的任务。

在下面的例子中，我们创建名为 “writeMsg()” 的函数。打开的花括号（{）指示函数代码的开始，而关闭的花括号（}）指示函数的结束。此函数输出 “Hello world!”。如需调用该函数，只要使用函数名即可：

?php

function writeMsg() {

echo “Hello world!”;

}

writeMsg(); // 调用函数

?

PHP 函数参数

可以通过参数向函数传递信息。参数类似变量。

参数被定义在函数名之后，括号内部。您可以添加任意多参数，只要用逗号隔开即可。

下面的例子中的函数有一个参数（$fname）。当调用 familyName() 函数时，我们同时要传递一个名字（例如 Bill），这样会输出不同的名字，但是姓氏相同：

?php

function familyName($fname) {

echo “$fname Zhang.br”;

}

familyName(“Li”);

familyName(“Hong”);

familyName(“Tao”);

familyName(“Xiao Mei”);

familyName(“Jian”);

?

下面的例子中的函数有两个参数（$fname 和 $year）：

?php

function familyName($fname,$year) {

echo “$fname Zhang. Born in $year br”;

}

familyName(“Li”,”1975″);

familyName(“Hong”,”1978″);

familyName(“Tao”,”1983″);

?

PHP 默认参数值

下面的例子展示了如何使用默认参数。如果我们调用没有参数的 setHeight() 函数，它的参数会取默认值：

?php

function setHeight($minheight=50) {

echo “The height is : $minheight br”;

}

setHeight(350);

setHeight(); // 将使用默认值 50

setHeight(135);

setHeight(80);

?

PHP 函数 – 返回值

如需使函数返回值，请使用 return 语句：

?php

function sum($x,$y) {

$z=$x+$y;

return $z;

}

echo “5 + 10 = ” . sum(5,10) . “br”;

echo “7 + 13 = ” . sum(7,13) . “br”;

echo “2 + 4 = ” . sum(2,4);

?