0

0

初学者学php注释怎么加_初学者学php注释添加规范【规范】

蓮花仙者

蓮花仙者

发布时间:2026-01-16 18:10:02

|

555人浏览过

|

来源于php中文网

原创

PHP注释应严格区分用途:单行用//(非#),多行用/ /,文档块用/* /且仅用于函数/类等需PHPDoc解析处;注释核心是提升可读性与可维护性。

初学者学php注释怎么加_初学者学php注释添加规范【规范】

PHP 注释本身没有强制语法错误,但加错位置、混用风格、或遗漏关键信息,会让后续维护的人(包括几天后的你自己)抓狂。最稳妥的做法是:单行用 //#,多行用 /* */,文档块用 /** */ —— 且仅在函数、类、常量前用。

单行注释该用 // 还是 #

# 在 PHP 中确实合法,但几乎没人用。它源于 shell 脚本习惯,容易和配置文件混淆,IDE 支持也弱。主流项目(Laravel、Symfony、PHP-FIG PSR 标准)全部默认 //

  • // 是 PHP 官方文档首选,所有内置函数示例都用它
  • # 在 CLI 脚本里偶尔出现,但一旦混进 Web 项目,会被 PHPCS(PHP CodeSniffer)直接报 Squiz.Commenting.InlineComment.InvalidEndChar
  • 别为了“省一个字符”牺牲可读性 —— // TODO: 检查用户权限# TODO: 检查用户权限 更易被编辑器高亮识别

/* */ 多行注释不能嵌套,但可以跨行写

PHP 不支持 /* /* 嵌套 */ */,会报 Parse error: syntax error, unexpected end of file。但它允许自然换行,只要不提前闭合。

/*
 * 用户登录逻辑:
 * - 验证邮箱格式
 * - 查询数据库是否存在
 * - 密码比对用 password_verify()
 */
if (filter_var($email, FILTER_VALIDATE_EMAIL)) { ... }
  • 每行开头加 * 是团队协作惯例,不是语法要求,但没它会被 PHPStan 或 PHP_CodeSniffer 的 Squiz.Commenting.BlockComment 规则警告
  • 别把 /* */ 当成“临时屏蔽代码”的工具 —— 用 if (false) { ... } 或 IDE 的注释快捷键更安全,否则容易漏掉 */ 导致整段代码失效

什么时候必须用 /** */ 文档块?

只有当你写的函数、类、属性、常量需要被 PHPDoc 工具(如 phpDocumentor、PHPStorm、Psalm)解析时才用。它不是普通注释,是结构化元数据。

Spell.tools
Spell.tools

高颜值AI内容营销创作工具

下载

立即学习PHP免费学习笔记(深入)”;

/**
 * 根据用户 ID 返回完整用户信息
 * @param int $id 用户唯一标识
 * @return array|null 包含 name/email/created_at 的关联数组,不存在时返回 null
 */
function getUserById(int $id): ?array { ... }
  • /** */ 必须紧贴函数/类声明上方,中间不能有空行,否则 PHPStorm 不会自动补全参数提示
  • @param@return 等标签的类型要和实际一致(比如写 @param string $id 却传了 int,Psalm 会报错)
  • 普通逻辑说明(比如“这里调用了第三方 API”)不要塞进 /** */,用 // 更轻量

最容易被忽略的是:注释不是写给机器看的,是写给下一个要改这段代码的人看的。如果一行 // 能说清,就别硬凑三行 /* */;如果函数行为复杂到需要类型和用途说明,那就老老实实写 /** */ 并保持字段对齐 —— 不为别的,就为下次 grep 时能快速定位。

相关专题

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

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

2580

2023.09.01

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

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

1617

2023.10.11

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

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

1504

2023.10.11

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

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

952

2023.10.23

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

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

1417

2023.10.23

html怎么上传
html怎么上传

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

1234

2023.11.03

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

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

1447

2023.11.09

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

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

1306

2023.11.13

高德地图升级方法汇总
高德地图升级方法汇总

本专题整合了高德地图升级相关教程,阅读专题下面的文章了解更多详细内容。

2

2026.01.16

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
PHP课程
PHP课程

共137课时 | 8.7万人学习

JavaScript ES5基础线上课程教学
JavaScript ES5基础线上课程教学

共6课时 | 7.2万人学习

PHP新手语法线上课程教学
PHP新手语法线上课程教学

共13课时 | 0.9万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号