0

0

C++怎么进行代码注释_C++单行与多行注释规范【指南】

冰火之心

冰火之心

发布时间:2026-03-14 20:00:14

|

868人浏览过

|

来源于php中文网

原创

<p>C++单行注释唯一合法写法是//,块注释只能用/ /且不支持嵌套;Doxygen风格注释(///、/* /)非语言特性但影响文档生成;注释需注意编码、预处理及工具链兼容性。</p>

c++怎么进行代码注释_c++单行与多行注释规范【指南】

单行注释用 //,别碰 #

单行注释唯一合法写法是 //,后面跟任意内容直到行尾。C++ 不支持 # 开头的注释(那是 Shell/Python 的习惯),写了会直接报错:error: expected unqualified-id

常见错误现象:复制 Python 脚本里的 #include <iostream> 注释风格,结果编译失败;或者在宏定义后误加 # 注释,导致预处理器把整行吞掉。

  • // 可以出现在行首,也可以跟在语句后面:int x = 42; // 初始化值
  • 不要在字符串字面量里用 //,它不会被忽略:std::string s = "a//b"; 中的 // 就是普通字符
  • 预处理指令后不能直接跟 //(中间至少一个空格或换行),否则可能被当作指令一部分

多行注释必须用 /* */,嵌套不合法

/* */ 是 C++ 唯一的块注释语法,从 /* 开始,到最近的 */ 结束。它不支持嵌套——这是最常踩的坑。

使用场景:临时屏蔽一段含 // 的代码、注释掉大段调试逻辑、写函数说明头部。

立即学习C++免费学习笔记(深入)”;

  • /* /* inner */ outer */ 会导致编译器只认第一个 */,后面内容全变未注释,大概率语法错误
  • /* 可以跨行,但不能跨字符串或字符字面量边界:"/*" 里的 /* 不触发注释
  • 如果注释里不小心漏了 */,编译器会一路吃到文件末尾甚至下一个文件(尤其头文件被多次包含时),报一堆“unexpected token”

Doxygen 风格注释不是语言特性,但影响生成文档

////** */ 是 Doxygen 约定,不是 C++ 标准语法。它们本身只是普通单行/块注释,但 Doxygen 工具能识别其中的 @param@return 等标签生成 API 文档。

聚好用AI
聚好用AI

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

下载

关键点在于:这些符号对编译器完全透明,但写错格式会让 Doxygen 漏解析。

  • 函数声明前用 ////** */ 才会被 Doxygen 捕获,写在函数体内无效
  • /** */ 中第一行的 * 和后续行对齐与否不影响编译,但 Doxygen 推荐统一缩进
  • 别混用:/// @brief/* @brief */ 都行,但 // @brief(单斜杠无空格)Doxygen 不识别

注释里出现 \ 或 Unicode 可能引发意外

注释内容虽不参与编译,但若含反斜杠续行或换行符,在某些老旧编译器或预处理器阶段可能被误处理;Unicode 注释则涉及源文件编码设置。

实际影响集中在跨平台协作和构建系统中。

  • // 这里有个反斜杠\ 下一行:部分编译器会把 \ 当作续行,导致注释“泄漏”到下一行
  • 含中文的注释必须保存为 UTF-8 无 BOM,否则 MSVC 可能显示乱码,Clang/GCC 则通常容忍
  • 避免在注释里写未转义的 HTML 实体或 XML 符号(如 <),虽然不报错,但可能干扰文档生成工具或 IDE 预览

注释不是写完就完的事——它得和代码一起被编辑、被搜索、被 IDE 折叠、被文档工具读取。最容易被忽略的是注释边界与预处理、编码、工具链之间的隐式耦合,而不是语法本身。

热门AI工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

WorkBuddy
WorkBuddy

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

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

更多
string转int
string转int

在编程中,我们经常会遇到需要将字符串(str)转换为整数(int)的情况。这可能是因为我们需要对字符串进行数值计算,或者需要将用户输入的字符串转换为整数进行处理。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

1051

2023.08.02

pdf怎么转换成xml格式
pdf怎么转换成xml格式

将 pdf 转换为 xml 的方法:1. 使用在线转换器;2. 使用桌面软件(如 adobe acrobat、itext);3. 使用命令行工具(如 pdftoxml)。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

1949

2024.04.01

xml怎么变成word
xml怎么变成word

步骤:1. 导入 xml 文件;2. 选择 xml 结构;3. 映射 xml 元素到 word 元素;4. 生成 word 文档。提示:确保 xml 文件结构良好,并预览 word 文档以验证转换是否成功。想了解更多xml的相关内容,可以阅读本专题下面的文章。

2119

2024.08.01

xml是什么格式的文件
xml是什么格式的文件

xml是一种纯文本格式的文件。xml指的是可扩展标记语言,标准通用标记语言的子集,是一种用于标记电子文件使其具有结构性的标记语言。想了解更多相关的内容,可阅读本专题下面的相关文章。

1171

2024.11.28

scripterror怎么解决
scripterror怎么解决

scripterror的解决办法有检查语法、文件路径、检查网络连接、浏览器兼容性、使用try-catch语句、使用开发者工具进行调试、更新浏览器和JavaScript库或寻求专业帮助等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

492

2023.10.18

500error怎么解决
500error怎么解决

500error的解决办法有检查服务器日志、检查代码、检查服务器配置、更新软件版本、重新启动服务、调试代码和寻求帮助等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

382

2023.10.25

登录token无效
登录token无效

登录token无效解决方法:1、检查token的有效期限,如果token已经过期,需要重新获取一个新的token;2、检查token的签名,如果签名不正确,需要重新获取一个新的token;3、检查密钥的正确性,如果密钥不正确,需要重新获取一个新的token;4、使用HTTPS协议传输token,建议使用HTTPS协议进行传输 ;5、使用双因素认证,双因素认证可以提高账户的安全性。

6654

2023.09.14

登录token无效怎么办
登录token无效怎么办

登录token无效的解决办法有检查Token是否过期、检查Token是否正确、检查Token是否被篡改、检查Token是否与用户匹配、清除缓存或Cookie、检查网络连接和服务器状态、重新登录或请求新的Token、联系技术支持或开发人员等。本专题为大家提供token相关的文章、下载、课程内容,供大家免费下载体验。

843

2023.09.14

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

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

49

2026.03.13

热门下载

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

精品课程

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

共94课时 | 11.3万人学习

C 教程
C 教程

共75课时 | 5.4万人学习

C++教程
C++教程

共115课时 | 21.9万人学习

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

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