0

0

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

P粉602998670

P粉602998670

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

|

702人浏览过

|

来源于php中文网

原创

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

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

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

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

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

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

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

比如:

餐饮E站通-在线订餐系统 免费版
餐饮E站通-在线订餐系统 免费版

在线订餐系统源码,提供给设计人员参考一个小型的在线订餐管理系统源码,采用三层模式开发,代码注释详细前台可以进行用户注册、菜单管理及订餐后台管理员可以进行菜单管理、新闻管理、菜肴管理、用户管理操作数据库采用的是Sql2005(由于数据库在App_Data下,如果装了Sql2005数据库会自动配置)

下载
// 计算总价并保留两位小数
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只能用多行注释

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

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

相关专题

更多
css
css

css是层叠样式表,用来表现HTML或XML等文件样式的计算机语言,不仅可以静态地修饰网页,还可以配合各种脚本语言动态地对网页各元素进行格式化。php中文网还为大家带来html的相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

500

2023.06.15

css居中
css居中

css居中:1、通过“margin: 0 auto; text-align: center”实现水平居中;2、通过“display:flex”实现水平居中;3、通过“display:table-cell”和“margin-left”实现居中。本专题为大家提供css居中的相关的文章、下载、课程内容,供大家免费下载体验。

261

2023.07.27

css如何插入图片
css如何插入图片

cssCSS是层叠样式表(Cascading Style Sheets)的缩写。它是一种用于描述网页或应用程序外观和样式的标记语言。CSS可以控制网页的字体、颜色、布局、大小、背景、边框等方面,使得网页的外观更加美观和易于阅读。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

731

2023.07.28

css超出显示...
css超出显示...

在CSS中,当文本内容超出容器的宽度或高度时,可以使用省略号来表示被隐藏的文本内容。本专题为大家提供css超出显示...的相关文章,相关教程,供大家免费体验。

534

2023.08.01

css字体颜色
css字体颜色

CSS中,字体颜色可以通过属性color来设置,用于控制文本的前景色,字体颜色在网页设计中起到很重要的作用,具有以下表现作用:1、提升可读性;2、强调重点信息;3、营造氛围和美感;4、用于呈现品牌标识或与品牌形象相符的风格。

748

2023.08.10

什么是css
什么是css

CSS是层叠样式表(Cascading Style Sheets)的缩写,是一种用于描述网页(或其他基于 XML 的文档)样式与布局的标记语言,CSS的作用和意义如下:1、分离样式和内容;2、页面加载速度优化;3、实现响应式设计;4、确保整个网站的风格和样式保持统一。

594

2023.08.10

css三角形怎么写
css三角形怎么写

CSS可以通过多种方式实现三角形形状,本专题为大家提供css三角形怎么写的相关教程,大家可以免费体验。

556

2023.08.21

css设置文字颜色
css设置文字颜色

CSS(层叠样式表)可以用于设置文字颜色,这样做有以下好处和优势:1、增加网页的可视化效果;2、突出显示某些重要的信息或关键字;3、增强品牌识别度;4、提高网页的可访问性;5、引起不同的情感共鸣。

387

2023.08.22

小游戏4399大全
小游戏4399大全

4399小游戏免费秒玩大全来了!无需下载、即点即玩,涵盖动作、冒险、益智、射击、体育、双人等全品类热门小游戏。经典如《黄金矿工》《森林冰火人》《狂扁小朋友》一应俱全,每日更新最新H5游戏,支持电脑与手机跨端畅玩。访问4399小游戏中心,重温童年回忆,畅享轻松娱乐时光!官方入口安全绿色,无插件、无广告干扰,打开即玩,快乐秒达!

30

2025.12.31

热门下载

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

精品课程

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

共23课时 | 2.1万人学习

C# 教程
C# 教程

共94课时 | 5.7万人学习

Java 教程
Java 教程

共578课时 | 39.8万人学习

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

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