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

单行注释与多行注释的正确书写规范

夏芳小哥_6726

夏芳小哥_6726

发布时间:2026-03-21 17:50:30

|

524人浏览过

|

来源于php中文网

原创

编程注释规范:单行用//,多行用/.../;单行适合简短说明或临时禁用代码,多行用于复杂逻辑或函数说明;Python、HTML、SQL等有各自语法;注释应解释“为什么”,并随代码及时更新。

单行注释与多行注释的正确书写规范

单行注释用 // 开头,多行注释用 /* ... */ 包裹,这是大多数编程语言(如 JavaScript、Java、C/C++、TypeScript 等)的通用规范。

单行注释:简洁说明当前行或上一行代码

适合简短说明、临时禁用某行代码、标注小功能点。

  • 写在代码上方或同行末尾,但保持可读性;同行末尾时,// 前至少留一个空格
  • 避免写过长句子,超过 80 字建议拆成多行或改用多行注释
  • 不要嵌套单行注释(虽然语法允许,但易出错且不清晰)
示例:
// 计算用户登录失败次数
let failCount = getUserFailures(userId); // 仅对当前行补充说明

多行注释:解释复杂逻辑、函数用途或大段临时屏蔽

适用于函数说明、算法描述、版权信息、临时注释掉多行代码等场景。

  • 开头用 /*,结尾用 */,中间每行无需额外符号,但常用 * 对齐提升可读性
  • 禁止嵌套多行注释(/* /* ... */ */ 会报错),需改用多个单行注释替代
  • 文档类注释(如 JSDoc)虽也用 /** ... */,但它属于扩展语法,不是基础多行注释
示例:
/*
* 验证邮箱格式是否合法
* 支持常见域名后缀,不校验 DNS 存在性
*/
function isValidEmail(str) { ... }

注意不同语言的细微差异

多数主流语言一致,但仍有例外:

  • Python 使用 # 表示单行注释,无原生多行注释语法(用三引号字符串模拟,但非真注释)
  • HTML 使用 ,不支持 // 或 /* */
  • SQL 中 -- 是单行注释,/* ... */ 是多行注释(部分方言如 MySQL 支持)

良好习惯:注释要“说人话”,更要随代码更新

注释不是装饰,而是协作和维护的关键线索。

  • 写注释前先想清楚:是解释“做什么”,还是“为什么这么做”?后者更有价值
  • 代码重构后,务必同步检查并更新相关注释,过时注释比没注释更危险
  • 避免无意义注释,例如 // i++ 或 // 返回 true

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

热门AI工具

更多
Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

豆包大模型

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

二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

超级简历WonderCV

一款AI办公效率工具,主要用于免费求职简历模版下载制作,应届生职场人必备简历制作神器,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

WorkBuddy

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

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

11797

2023.06.15

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

8882

2023.07.05

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

7632

2023.07.31

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

1244

2023.08.01

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

1008

2023.08.02

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

1496

2023.08.02

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

3089

2023.08.02

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

20351

2023.08.03

Uvicorn 报错与问题解决教程
Uvicorn 报错与问题解决教程

本专题汇总了Uvicorn服务器常见问题与报错解决的教程合集,涵盖启动失败、端口占用、模块导入错误、事件循环冲突及热重载失效等典型故障的排查思路。同时整理了多进程与Worker配置、SSL/HTTPS证书报错、跨域与代理配置等实战解决方案,助你快速定位并解决Uvicorn运行中的各类问题。

20

2026.11.02

热门下载

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

精品课程

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

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