C++ 注解(注释)完整讲解
你要的是C++ 注解(注释),我给你最清晰、最标准、最实用的版本,直接能写进文档、笔记、教程。
一、什么是 C++ 注解(注释)
C++ 注解 = 注释
是写在代码里给人看、不给编译器看 的文字。
编译器会完全忽略注释,不会编译进程序。
作用:
- 解释代码功能
- 记录作者、时间、版本
- 临时屏蔽代码
- 方便团队协作阅读
二、C++ 有 2 种标准注释语法
1. 单行注释://
从 // 开始到本行结束,都是注释。
cpp
// 这是单行注释
int a = 10; // 解释变量a的作用
2. 多行注释:/* */
可以跨多行,适合写长说明。
cpp
/*
这是多行注释
可以写很多行内容
编译器全部忽略
*/
int b = 20;
三、注释的规范写法(行业通用)
1. 文件头注释(放在 .h / .cpp 最上方)
cpp
/*
* 文件名:demo.cpp
* 作者:XXX
* 日期:2025-XX-XX
* 功能:演示C++注释用法
*/
2. 函数注释
cpp
// 计算两数之和
int add(int x, int y) {
return x + y;
}
3. 关键代码段注释
cpp
// 初始化日志系统
initLog();
// 启动网络连接
startNetwork();
四、注释的 3 个重要原则
- 不废话:不要解释 obvious 的代码
- 简洁清晰:一句话说清功能
- 保持更新:代码改了,注释也要改
五、常见错误
-
不要嵌套多行注释:
cpp/* 外层 /* 内层 */ 错误 */ -
不要用注释代替烂代码(代码要写干净)
超简短总结(适合PPT)
//单行注释/* */多行注释- 给人看,编译器忽略
- 用于解释、记录、调试