很多站长朋友们都不太清楚php函数注释规范,今天小编就来给大家整理php函数注释规范,希望对各位有所帮助,具体内容如下:
本文目录一览: 1、 php的函数中参数的命名规范是怎样的 2、 PHPstorm自动生成方法注释规则配置 3、 什么是PHP的函数? 4、 php中如何给类规范的注释 php的函数中参数的命名规范是怎样的参数的命名规范和变量的命名规范是一样的:
1.必须要以$开始。如变量x必须要写成$x
2.变量的首字母不能以数字开始
3.变量的名字区分大小写
4.变量不要用
特殊符号
、中文,_不算特殊符号
5.变量命名要有意义(别写xxx,aaa,ccc这种
变量名)
具体的话可以参考php中文网的介绍,希望对你有帮助
PHPstorm自动生成方法注释规则配置首先你得安装好java以及配置好环境变量,能在cmd里面运行java。win+R弹出运行窗口输入cmd回车,进入dos界面,输入java-version,检查java是否配置好。
配置好java后,我们新建一个含有公共类的java文件,在里面随便写点东西。然后保存到文件夹test里面,在文件夹里面空白处,按住shift键,然后点击鼠标右键,出现:在此处打开命令窗口,点击进入命令窗口,然后输入javadoc(空格)DemoA.java,回车,会跳出正在生成api注释文档,我们点击index.html即可查看文档。
PHPSTORM的快速生成注释的方法:设置头部注释、类注释以及函数注释,时间、用户名、文件名称等随机改变的属性,直接使用其下方已经定义的属性即可。生成注释,输入”/**,“按”enter“键即可出现对应注释内容。
什么是PHP的函数?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);
?>
php中如何给类规范的注释需要准备的材料分别是:电脑、phpstrom编辑器。
1、首先,打开phpstrom编辑器,新建php文件,例如:index.php,定义一个函数示例。
2、在function的上方一行,输入:/**,然后按回车。
3、此时会发现phpstrom编辑器将函数的注释自动生成了。
关于php函数注释规范的介绍到此就结束了,不知道本篇文章是否对您有帮助呢?如果你还想了解更多此类信息,记得收藏关注本站,我们会不定期更新哦。
查看更多关于php函数注释规范 php的注释有哪些的详细内容...