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

C++怎么写注释 C++单行注释与多行注释规范【归纳】

落伟小哥_3191

落伟小哥_3191

发布时间:2026-03-08 12:46:03

|

904人浏览过

|

来源于php中文网

原创

<p>C++注释分//单行和/ /多行,禁止嵌套;/**/非标准但Doxygen支持;注释应解释“为什么”而非“怎么做”,避免冗余,宏内慎用注释,#if 0更安全屏蔽代码。</p>

c++怎么写注释 c++单行注释与多行注释规范【归纳】

C++单行注释用//,多行注释用/* */,但嵌套不合法

单行注释从//开始到行末结束,多行注释以/*开头、*/结尾。C++标准明确禁止/*嵌套/*——编译器会把第一个*/当作外层注释的结束,导致后续代码被意外注释掉。

  • 常见错误现象:/* /* inner */ outer */ 编译失败或逻辑错乱,实际只识别到第一个*/
  • 使用场景:单行注释适合说明变量用途、短逻辑意图;多行注释更适合临时屏蔽大段代码(调试时)或写较长的接口说明
  • 注意//后面空格不是必须的,但加空格更易读(如// fix: handle nullptr比//fix:handle nullptr清晰)

/**不是C++标准语法,但部分IDE支持Doxygen解析

纯C++不认/**这种写法——它只是/*后跟一个*,属于普通多行注释的变体。但像VS Code、CLion等工具配合Doxygen插件时,会把/**开头的块识别为文档注释,并提取生成API文档。

  • 参数差异:Doxygen识别@param、@return等标签,但这些对编译器完全透明,删掉也不影响编译
  • 容易踩的坑:误以为/**有特殊语义,结果在没装Doxygen或没配置插件的环境里,只当它是普通注释,文档根本不出
  • 性能/兼容性:无运行时开销,但过度依赖Doxygen标签会让注释和代码耦合变强,换工具链时可能丢失文档能力

注释不能放在#define宏定义中间或预处理指令之后

预处理器在编译前就处理#define、#include等指令,而注释是编译器阶段才解析的。如果在宏展开体内混入注释,可能导致宏行为异常。

C++14
C++14

C++14 对 C++11 的修正与增强版本,适合旧系统维护和较老工具链兼容。

下载
  • 常见错误现象:#define LOG(x) printf("log: " #x "\n"); /* debug only */ 看似正常,但若宏被用在条件编译中,注释位置可能干扰预处理器判断
  • 更安全的做法是把注释放在宏定义上方或下方,例如:
    #define LOG(x) printf("log: " #x "\n")<br>// only enabled in DEBUG build
  • 特别注意:#if 0 ... #endif是比/* */更可靠的代码屏蔽方式,因为它在预处理阶段就被剔除,不会参与词法分析

函数内部注释别解释“怎么写”,要说明“为什么这么写”

比如i++和++i在循环里效果一样,但注释写成“这里用前置递增”不如写成“避免拷贝临时对象(针对自定义迭代器)”。后者指向真实约束。

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

  • 容易踩的坑:注释描述代码字面意思(如// loop from 0 to n-1),等于重复代码,维护时极易过期
  • 推荐模式:用注释补全代码无法表达的信息——边界条件依据、算法选型理由、规避的已知bug编号、线程安全假设
  • 示例:// use std::vector::reserve() here to avoid reallocations during batch insert (see issue #287)

注释的生命力取决于它是否承载了代码本身无法表达的上下文。一旦你发现自己在注释里写“这个for循环遍历数组”,就该停下来想想:是不是变量名或结构可以改得更直白?或者,真正需要写下来的,其实是“为什么必须顺序遍历而不是随机访问”?

热门AI工具

更多
DeepSeek

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

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

WorkBuddy

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

讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

PixPix
PixPix Hot

PixPix是一款面向电商视觉生产的AI商品图生成工具。

SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

豆包大模型

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

Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

相关专题

更多
typedef和define区别
typedef和define区别

typedef和define区别在类型检查、作用范围、可读性、错误处理和内存占用等。本专题为大家提供typedef和define相关的文章、下载、课程内容,供大家免费下载体验。

313

2023.09.26

define的用法
define的用法

define用法:1、定义常量;2、定义函数宏:3、定义条件编译;4、定义多行宏。更多关于define的用法的内容,大家可以阅读本专题下的文章。

619

2023.10.11

printf用法大全
printf用法大全

php中文网为大家提供printf用法大全,以及其他printf函数的相关文章、相关下载资源以及各种相关课程,供大家免费下载体验。

808

2023.06.20

fprintf和printf的区别
fprintf和printf的区别

fprintf和printf的区别在于输出的目标不同,printf输出到标准输出流,而fprintf输出到指定的文件流。根据需要选择合适的函数来进行输出操作。更多关于fprintf和printf的相关文章详情请看本专题下面的文章。php中文网欢迎大家前来学习。

1029

2023.11.28

硬盘接口类型介绍
硬盘接口类型介绍

硬盘接口类型有IDE、SATA、SCSI、Fibre Channel、USB、eSATA、mSATA、PCIe等等。详细介绍:1、IDE接口是一种并行接口,主要用于连接硬盘和光驱等设备,它主要有两种类型:ATA和ATAPI,IDE接口已经逐渐被SATA接口;2、SATA接口是一种串行接口,相较于IDE接口,它具有更高的传输速度、更低的功耗和更小的体积;3、SCSI接口等等。

3168

2023.10.19

PHP接口编写教程
PHP接口编写教程

本专题整合了PHP接口编写教程,阅读专题下面的文章了解更多详细内容。

4969

2025.10.17

php8.4实现接口限流的教程
php8.4实现接口限流的教程

PHP8.4本身不内置限流功能,需借助Redis(令牌桶)或Swoole(漏桶)实现;文件锁因I/O瓶颈、无跨机共享、秒级精度等缺陷不适用高并发场景。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

3789

2025.12.29

java接口相关教程
java接口相关教程

本专题整合了java接口相关内容,阅读专题下面的文章了解更多详细内容。

466

2026.01.19

Gradle插件开发入门教程
Gradle插件开发入门教程

本专题介绍Gradle插件开发的基本流程,涵盖插件类编写、自定义任务注册、扩展参数设计和插件应用方法,帮助你理解插件如何组织构建逻辑,减少多个项目之间的重复配置。

0

2026.10.22

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
C++ Core Guidelines
C++ Core Guidelines

共0课时 | 0人学习

C++ Reference
C++ Reference

共0课时 | 0人学习

C++ 官方标准说明
C++ 官方标准说明

共0课时 | 0人学习

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

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