php 注释类型有三种:单行注释://多行注释:/ /文档注释:/ /
PHP 注释类型
PHP 语言提供了三种注释类型,用于向代码添加说明和元数据:
1. 单行注释(//)
单行注释开始于两个斜杠 (//),一直持续到行尾。它用于添加对单行代码的简短说明。
示例:
立即学习“PHP免费学习笔记(深入)”;
// 计算总和
$sum = $a + $b;
2. 多行注释(/ /)
多行注释开始于 /,结束于 /。它用于添加对代码块或函数的更长的描述。
示例:
立即学习“PHP免费学习笔记(深入)”;
/*
* 计算两个数字的总和
*
* @param int $a 第一个数字
* @param int $b 第二个数字
* @return int 总和
*/
function sum($a, $b) {
return $a + $b;
}
3. 文档注释(/ /)*
文档注释是一种特殊的注释类型,用于为函数、类和属性生成文档。它开始于 /*,结束于 /。
文档注释包含以下结构:
- 描述:注释的第一行,简要描述代码元素。
- 标签:以 @ 开头的元数据,提供有关代码元素的附加信息,例如 @param、@return 和 @throws。
- 正文:注释的其余部分,提供有关代码元素的更详细说明。
示例:
立即学习“PHP免费学习笔记(深入)”;
/**
* 计算两个数字的总和
*
* @param int $a 第一个数字
* @param int $b 第二个数字
* @return int 总和
*/
function sum($a, $b) {
return $a + $b;
}