0

0

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

蓮花仙者

蓮花仙者

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

|

575人浏览过

|

来源于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。但它允许自然换行,只要不提前闭合。

XiaoHu.AI
XiaoHu.AI

由小互建立的一个AI资讯、教程、课程、工具以及开源项目案例的平台。

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

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

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

立即学习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 时能快速定位。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
PHP Symfony框架
PHP Symfony框架

本专题专注于PHP主流框架Symfony的学习与应用,系统讲解路由与控制器、依赖注入、ORM数据操作、模板引擎、表单与验证、安全认证及API开发等核心内容。通过企业管理系统、内容管理平台与电商后台等实战案例,帮助学员全面掌握Symfony在企业级应用开发中的实践技能。

85

2025.09.11

laravel组件介绍
laravel组件介绍

laravel 提供了丰富的组件,包括身份验证、模板引擎、缓存、命令行工具、数据库交互、对象关系映射器、事件处理、文件操作、电子邮件发送、队列管理和数据验证。想了解更多laravel的相关内容,可以阅读本专题下面的文章。

338

2024.04.09

laravel中间件介绍
laravel中间件介绍

laravel 中间件分为五种类型:全局、路由、组、终止和自定。想了解更多laravel中间件的相关内容,可以阅读本专题下面的文章。

290

2024.04.09

laravel使用的设计模式有哪些
laravel使用的设计模式有哪些

laravel使用的设计模式有:1、单例模式;2、工厂方法模式;3、建造者模式;4、适配器模式;5、装饰器模式;6、策略模式;7、观察者模式。想了解更多laravel的相关内容,可以阅读本专题下面的文章。

708

2024.04.09

thinkphp和laravel哪个简单
thinkphp和laravel哪个简单

对于初学者来说,laravel 的入门门槛较低,更易上手,原因包括:1. 更简单的安装和配置;2. 丰富的文档和社区支持;3. 简洁易懂的语法和 api;4. 平缓的学习曲线。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

384

2024.04.10

laravel入门教程
laravel入门教程

本专题整合了laravel入门教程,想了解更多详细内容,请阅读专题下面的文章。

133

2025.08.05

laravel实战教程
laravel实战教程

本专题整合了laravel实战教程,阅读专题下面的文章了解更多详细内容。

82

2025.08.05

laravel面试题
laravel面试题

本专题整合了laravel面试题相关内容,阅读专题下面的文章了解更多详细内容。

75

2025.08.05

Swift iOS架构设计与MVVM模式实战
Swift iOS架构设计与MVVM模式实战

本专题聚焦 Swift 在 iOS 应用架构设计中的实践,系统讲解 MVVM 模式的核心思想、数据绑定机制、模块拆分策略以及组件化开发方法。内容涵盖网络层封装、状态管理、依赖注入与性能优化技巧。通过完整项目案例,帮助开发者构建结构清晰、可维护性强的 iOS 应用架构体系。

0

2026.03.03

热门下载

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

精品课程

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

共137课时 | 12.8万人学习

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

共6课时 | 11.3万人学习

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

共13课时 | 1.0万人学习

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

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