0

0

如何注释代码?使用//单行或/* */多行注释

P粉602998670

P粉602998670

发布时间:2025-06-28 13:20:02

|

702人浏览过

|

来源于php中文网

原创

<p>写代码时加注释是为了提高代码可读性,方便自己和他人理解。应在关键地方添加注释,单行注释(//)适合解释单行代码或变量作用,如说明逻辑目的、调试屏蔽代码;多行注释(/ /)适合完整说明函数用途、参数含义及注意事项,并可用于临时屏蔽代码段;注释应清晰实用,避免重复代码内容、不相关背景或过时信息,应说明“为什么”而非仅“做了什么”,并标明公共函数的输入输出及副作用;选择单行或多行注释取决于内容长度与上下文需求,html/css中只能使用多行注释;团队开发中应遵循统一规范,保持风格一致。</p>

如何注释代码?使用//单行或/* */多行注释

写代码时加注释,是让自己和别人以后更容易看懂这段代码在干什么。很多人一开始写代码都不太注意注释,结果回过头来看自己写的代码都得想半天。其实只要在关键地方加上几句说明,就能省掉很多理解成本。

如何注释代码?使用//单行或/* */多行注释

什么时候该用单行注释(//)

单行注释适合写在某一行代码的上方或后面,用来解释这行代码做了什么。它的优点是简洁,不会显得累赘。

如何注释代码?使用//单行或/* */多行注释

比如:

聚好用AI
聚好用AI

可免费AI绘图、AI音乐、AI视频创作,聚集全球顶级AI,一站式创意平台

下载
// 计算总价并保留两位小数
const totalPrice = (price * quantity).toFixed(2);

或者像这样写在代码后面:

如何注释代码?使用//单行或/* */多行注释
let count = 0; // 初始化计数器

适用场景:

  • 解释某个变量的作用
  • 说明某段逻辑的目的
  • 暂时屏蔽某行代码(调试时常用)

这种写法特别适合在函数内部、逻辑分支里做简单说明,不需要大段文字也能让人一目了然。


多行注释(/ /)更适合哪些情况

多行注释适合写一段比较完整的说明,比如函数用途、参数含义、注意事项等。它不会打断代码结构,适合写稍长一点的解释。

比如:

/*
 * 获取用户信息
 * 参数:
 *   userId: 用户唯一标识符
 * 返回值:
 *   包含用户名和邮箱的对象
 */
function getUserInfo(userId) {
  // ...
}

也可以临时把一段代码“注释掉”来测试效果:

/*
console.log('调试信息');
fetchData();
*/

不过要注意的是,在有些语言中(比如HTML、CSS),只能使用多行注释,不能用//


注释也要讲究清晰和实用

写注释不是为了凑字数,而是要写出真正有用的信息。比如下面这些做法就不太合适:

  • 注释内容和代码重复:“设置标题”写在title = '首页'旁边
  • 写一堆不相关的背景故事
  • 忘记更新注释,导致注释和实际代码不符

好注释的标准:

  • 简洁明确,不说废话
  • 解释“为什么”,而不是“做了什么”
  • 如果是公共函数,说明输入输出和副作用

比如这样写更好:

// 需要先转成整数,防止字符串拼接出错
const num = parseInt(inputValue, 10);

单行还是多行?看场景选就好

没有绝对正确的选择,主要看你要表达的内容长度和上下文是否需要。一般来说:

  • 想说一句两句,用//
  • 要写个说明文档式的注释,用/* */
  • 在不同语言中也略有差异,比如HTML/CSS只能用多行注释

另外,团队有统一规范的话,按规范来就行。如果没有,保持一致风格也很重要。

基本上就这些。写注释不是难事,但确实容易被忽略。花点时间写清楚,回头省不少麻烦。

热门AI工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

更多
堆和栈的区别
堆和栈的区别

堆和栈的区别:1、内存分配方式不同;2、大小不同;3、数据访问方式不同;4、数据的生命周期。本专题为大家提供堆和栈的区别的相关的文章、下载、课程内容,供大家免费下载体验。

448

2023.07.18

堆和栈区别
堆和栈区别

堆(Heap)和栈(Stack)是计算机中两种常见的内存分配机制。它们在内存管理的方式、分配方式以及使用场景上有很大的区别。本文将详细介绍堆和栈的特点、区别以及各自的使用场景。php中文网给大家带来了相关的教程以及文章欢迎大家前来学习阅读。

606

2023.08.10

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

49

2026.03.13

Python异步编程与Asyncio高并发应用实践
Python异步编程与Asyncio高并发应用实践

本专题围绕 Python 异步编程模型展开,深入讲解 Asyncio 框架的核心原理与应用实践。内容包括事件循环机制、协程任务调度、异步 IO 处理以及并发任务管理策略。通过构建高并发网络请求与异步数据处理案例,帮助开发者掌握 Python 在高并发场景中的高效开发方法,并提升系统资源利用率与整体运行性能。

88

2026.03.12

C# ASP.NET Core微服务架构与API网关实践
C# ASP.NET Core微服务架构与API网关实践

本专题围绕 C# 在现代后端架构中的微服务实践展开,系统讲解基于 ASP.NET Core 构建可扩展服务体系的核心方法。内容涵盖服务拆分策略、RESTful API 设计、服务间通信、API 网关统一入口管理以及服务治理机制。通过真实项目案例,帮助开发者掌握构建高可用微服务系统的关键技术,提高系统的可扩展性与维护效率。

272

2026.03.11

Go高并发任务调度与Goroutine池化实践
Go高并发任务调度与Goroutine池化实践

本专题围绕 Go 语言在高并发任务处理场景中的实践展开,系统讲解 Goroutine 调度模型、Channel 通信机制以及并发控制策略。内容包括任务队列设计、Goroutine 池化管理、资源限制控制以及并发任务的性能优化方法。通过实际案例演示,帮助开发者构建稳定高效的 Go 并发任务处理系统,提高系统在高负载环境下的处理能力与稳定性。

59

2026.03.10

Kotlin Android模块化架构与组件化开发实践
Kotlin Android模块化架构与组件化开发实践

本专题围绕 Kotlin 在 Android 应用开发中的架构实践展开,重点讲解模块化设计与组件化开发的实现思路。内容包括项目模块拆分策略、公共组件封装、依赖管理优化、路由通信机制以及大型项目的工程化管理方法。通过真实项目案例分析,帮助开发者构建结构清晰、易扩展且维护成本低的 Android 应用架构体系,提升团队协作效率与项目迭代速度。

99

2026.03.09

JavaScript浏览器渲染机制与前端性能优化实践
JavaScript浏览器渲染机制与前端性能优化实践

本专题围绕 JavaScript 在浏览器中的执行与渲染机制展开,系统讲解 DOM 构建、CSSOM 解析、重排与重绘原理,以及关键渲染路径优化方法。内容涵盖事件循环机制、异步任务调度、资源加载优化、代码拆分与懒加载等性能优化策略。通过真实前端项目案例,帮助开发者理解浏览器底层工作原理,并掌握提升网页加载速度与交互体验的实用技巧。

105

2026.03.06

Rust内存安全机制与所有权模型深度实践
Rust内存安全机制与所有权模型深度实践

本专题围绕 Rust 语言核心特性展开,深入讲解所有权机制、借用规则、生命周期管理以及智能指针等关键概念。通过系统级开发案例,分析内存安全保障原理与零成本抽象优势,并结合并发场景讲解 Send 与 Sync 特性实现机制。帮助开发者真正理解 Rust 的设计哲学,掌握在高性能与安全性并重场景中的工程实践能力。

230

2026.03.05

热门下载

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

精品课程

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

共23课时 | 4.4万人学习

C# 教程
C# 教程

共94课时 | 11.3万人学习

Java 教程
Java 教程

共578课时 | 82.1万人学习

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

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