讲师中心 微信公众号
AI工具推荐 视频效率加速

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

秋婷君_9078

秋婷君_9078

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

|

822人浏览过

|

来源于php中文网

原创

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

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

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

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

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

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

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

比如:

Java Maven Code Review
Java Maven Code Review

审查Java Maven项目(ZIP压缩包或GitLab仓库URL),检查代码规范、命名、模块边界、可维护性问题以及重复代码。

下载
// 计算总价并保留两位小数
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是一款面向对话、写作、编程和推理场景的AI大模型工具。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

切问学术

切问学术是一款AI论文写作工具,复旦大学NLP团队推出的AI学术智能体。

UP简历
UP简历 Hot

一款AI办公效率工具,主要用于基于AI技术的免费在线简历制作工具,适合需要提升相关任务效率的用户。

火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

LibLibAI
LibLibAI Hot

一款AI视频创作工具,主要用于国内领先的AI创意平台,以海量模型、低门槛操作与“创作-分享-商业化”生态,让小白与专业创作者都能高效实现图文乃至视频创意表达,适合需要提升相关任务效率的用户。

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

相关专题

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

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

5227

2023.07.18

堆和栈区别
堆和栈区别

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

2308

2023.08.10

FrankenPHP集成Laravel详细教程
FrankenPHP集成Laravel详细教程

本专题提供FrankenPHP集成Laravel的详细配置指南,全面解析运行原理、开发环境搭建、Caddyfile配置、Octane工作模式、数据库连接、队列任务、定时任务和生产环境优化,解决部署过程中常见的报错与兼容性问题。

0

2026.10.08

LLVM自定义Pass怎么写
LLVM自定义Pass怎么写

本专题聚焦LLVM自定义Pass开发,整理Pass类结构、run()方法、PreservedAnalyses、CMake构建、插件注册、-load-pass-plugin加载和测试用例编写流程。

120

2026.09.30

LLVM RISC-V参数配置教程
LLVM RISC-V参数配置教程

本专题介绍LLVM对RISC-V基础ISA和扩展的支持方式,涵盖RV32、RV64、标准扩展、实验性扩展、厂商扩展、-menable-experimental-extensions和版本差异。

100

2026.09.30

LLVM IR中间表示入门指南
LLVM IR中间表示入门指南

本专题整理LLVM IR的核心概念,包括中间表示作用、模块结构、函数、基本块、SSA形式、类型系统和常见语法,帮助新手理解LLVM编译流程中的关键层。

80

2026.09.30

PDF转图片方法
PDF转图片方法

需要把 PDF 页面用于上传、预览、分享或图片归档时,PDF 转图片方法专题整理 JPG/PNG 格式选择、逐页导出、清晰度设置、批量下载和结果检查等流程,帮助用户稳定完成 PDF 图片化处理。

80

2026.09.30

PixTV AI视频生成与无限画布创作
PixTV AI视频生成与无限画布创作

PixTV专题整理AI视频与视觉内容创作相关功能使用教程,涵盖AI生图、视频生成、无限画布、多模型创作、素材管理、声音音乐及视频剪辑等功能,帮助用户快速掌握PixTV从创意到成片的完整制作方法。

100

2026.09.29

Buffalo框架数据库开发全教程
Buffalo框架数据库开发全教程

本专题围绕Buffalo框架数据库开发,讲解database.yml多环境配置、soda与fizz迁移生成回滚、模型结构体标签、增删改查与条件查询、一对多与多对多关联、数据校验、回调钩子、事务处理及原生SQL执行能力。

300

2026.09.23

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
dev.java 官方:Learn Java
dev.java 官方:Learn Java

共0课时 | 0人学习

Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn