PHP注释添加方法图文教程:一看就会系列【可视化教学】

秋静小哥_5147

秋静小哥_5147

2026-06-12

764人浏览

原创

php注释分单行(//、#)、多行(/.../)和文档注释(/*.../)三种,分别适用于简短说明、功能描述和api文档生成,关键在于清晰表达意图而非重复代码。

php注释添加方法图文教程:一看就会系列【可视化教学】

PHP注释不难,关键是要用对地方、写得清楚。写好注释不是为了应付检查,而是帮自己和别人快速看懂代码逻辑,尤其在团队协作或隔几个月回看时特别有用。

单行注释:用//或#

适合简短说明,比如解释某一行的作用、临时禁用某行代码,或者标注小提醒。

  • // 后面所有内容直到行尾都被忽略(最常用)
  • # 效果一样,但用得少,多见于 shell 脚本习惯迁移过来的开发者
  • 可以放在代码同一行末尾,也可以单独占一行

示例:

btpanel phpsite 宝塔面板PHP网站
btpanel phpsite 宝塔面板PHP网站

宝塔面板 PHP 网站管理:站点创建、删除、启停、PHP 版本切换、域名管理、SSL证书管理、伪静态管理、数据库管理

下载
// 这是单行注释,不会执行<br>$name = "张三"; // 获取用户姓名<br># 这也是单行注释,效果相同

多行注释:用/* ... */

适合描述一段代码的功能、参数含义、修改原因,或者临时屏蔽一大段代码。

  • 从 /* 开始,到最近的 */ 结束,中间所有内容(包括换行)都不执行
  • 不能嵌套使用,即 /* ... /* ... */ ... */ 会报错
  • 常用于函数上方说明用途、输入输出、作者和时间等

示例:

/*<br> * 计算用户积分总和<br> * @param array $scores 用户各科目分数数组<br> * @return int 总分<br> */<br>function calcTotal($scores) {<br>    return array_sum($scores);<br>}

文档注释(PHPDoc):用/** ... */

这是带格式的多行注释,专门用于生成API文档(如用 phpDocumentor 工具),也方便IDE识别类型和自动提示。

  • 必须以 /** 开头,*/ 结尾,中间每行通常以 * 对齐
  • 支持标准标签,如 @param、@return、@var、@throws 等
  • IDE(如 PhpStorm、VS Code 配合插件)能据此显示悬停提示、参数补全

示例:

/**<br> * 根据用户ID查询完整资料<br> * @param int $id 用户唯一标识<br> * @return array|null 用户数据或 null(未找到)<br> * @throws InvalidArgumentException 当ID非正整数时抛出异常<br> */<br>function getUserById($id) {<br>    if (!is_int($id) || $id         throw new InvalidArgumentException("ID must be positive integer");<br>    }<br>    return ['id' => $id, 'name' => '李四'];<br>}

实用建议:什么时候该写、怎么写才有效

注释不是越多越好,而是要解决“为什么这么写”“这段代码干啥用”的问题。

  • 避免重复代码本身——$i++; 后面写“让i加1”毫无意义
  • 优先解释意图和边界条件——比如“此处需兼容旧版API返回空字符串而非null”
  • 函数开头用 PHPDoc,关键分支逻辑旁加单行注释说明判断依据
  • 删掉过期注释——代码改了但注释没更新,比没注释更误导人

不复杂但容易忽略。

php免费学习视频:立即使用
踏上前端学习之旅,开启通往精通之路!从前端基础到项目实战,循序渐进,一步一个脚印,迈向巅峰!

相关文章

PHP速学教程(入门到精通)
PHP速学教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

php

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
php文件怎么打开
php文件怎么打开

打开php文件步骤:1、选择文本编辑器;2、在选择的文本编辑器中,创建一个新的文件,并将其保存为.php文件;3、在创建的PHP文件中,编写PHP代码;4、要在本地计算机上运行PHP文件,需要设置一个服务器环境;5、安装服务器环境后,需要将PHP文件放入服务器目录中;6、一旦将PHP文件放入服务器目录中,就可以通过浏览器来运行它。

2023.09.01

11164

6

php怎么取出数组的前几个元素
php怎么取出数组的前几个元素

取出php数组的前几个元素的方法有使用array_slice()函数、使用array_splice()函数、使用循环遍历、使用array_slice()函数和array_values()函数等。本专题为大家提供php数组相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.11

6481

5

php反序列化失败怎么办
php反序列化失败怎么办

php反序列化失败的解决办法检查序列化数据。检查类定义、检查错误日志、更新PHP版本和应用安全措施等。本专题为大家提供php反序列化相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.11

2155

5

php怎么连接mssql数据库
php怎么连接mssql数据库

连接方法:1、通过mssql_系列函数;2、通过sqlsrv_系列函数;3、通过odbc方式连接;4、通过PDO方式;5、通过COM方式连接。想了解php怎么连接mssql数据库的详细内容,可以访问下面的文章。

2023.10.23

4108

4

php连接mssql数据库的方法
php连接mssql数据库的方法

php连接mssql数据库的方法有使用PHP的MSSQL扩展、使用PDO等。想了解更多php连接mssql数据库相关内容,可以阅读本专题下面的文章。

2023.10.23

4814

6

html怎么上传
html怎么上传

html通过使用HTML表单、JavaScript和PHP上传。更多关于html的问题详细请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.03

3771

9

PHP出现乱码怎么解决
PHP出现乱码怎么解决

PHP出现乱码可以通过修改PHP文件头部的字符编码设置、检查PHP文件的编码格式、检查数据库连接设置和检查HTML页面的字符编码设置来解决。更多关于php乱码的问题详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.09

5437

8

php文件怎么在手机上打开
php文件怎么在手机上打开

php文件在手机上打开需要在手机上搭建一个能够运行php的服务器环境,并将php文件上传到服务器上。再在手机上的浏览器中输入服务器的IP地址或域名,加上php文件的路径,即可打开php文件并查看其内容。更多关于php相关问题,详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.13

4242

8

sprintf函数用法详解
sprintf函数用法详解

sprintf函数的用法:1、格式化字符串;2、指定输出宽度和精度;3、返回值。更多关于sprintf函数用法详解的内容,大家可以阅读下面的文章。

2023.11.27

12142

4

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
墨刀帮助中心
墨刀帮助中心

共0课时 | 0人学习

MyEclipse学习中心
MyEclipse学习中心

共0课时 | 0人学习

Apache Subversion 官方手册
Apache Subversion 官方手册

共0课时 | 0人学习