C++ 注解(注释)完整讲解

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 个重要原则

  1. 不废话:不要解释 obvious 的代码
  2. 简洁清晰:一句话说清功能
  3. 保持更新:代码改了,注释也要改

五、常见错误

  • 不要嵌套多行注释:

    cpp 复制代码
    /* 外层 /* 内层 */ 错误 */
  • 不要用注释代替烂代码(代码要写干净)


超简短总结(适合PPT)

  • // 单行注释
  • /* */ 多行注释
  • 给人看,编译器忽略
  • 用于解释、记录、调试

相关推荐
Reisentyan13 小时前
[Review]GoLang Learn Data Day 3
java·开发语言·golang
H_老邪13 小时前
Java基础-Java 核心语法与面向对象(底层原理级)篇
java·开发语言
承渊政道13 小时前
我的创作纪念日写在创作第256天:从第一篇C语言博客,到一路向前的自己!
c语言·开发语言·笔记·学习·学习方法
暗冰ཏོ13 小时前
Java 后端开发完整学习指南:从基础语法到 Spring Boot 项目实战
java·spring boot·后端·spring·java-ee
牵着毛驴唱着歌14 小时前
JaVers 版本历史功能完整实现指南
java·javers·变更记录
山有木兮啊14 小时前
Windows C++ 跨 CRT 内存管理与安全释放
开发语言·c++·windows
lly20240614 小时前
Linux Memcached 安装指南
开发语言
止语Lab14 小时前
从文件到配置中心:Go 配置管理的三个升级拐点
开发语言·后端·golang
better_liang14 小时前
每日Java面试场景题知识点之-JUC并发编程核心原理与实战
java·线程池·并发编程·juc·aqs·reentrantlock·concurrenthashmap