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)

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

相关推荐
SL_staff5 分钟前
企业AI落地难?JVS-AI渐进式实践:安全可控、小切口验证、标准化沉淀与规模化复制
java·开源·aigc
David猪大卫19 分钟前
【C++修炼】map 和 set 的使用
c语言·开发语言·数据结构·c++·经验分享·笔记·学习
HPtiger27 分钟前
C++ 入门笔记:从 C 到 C++ 的核心过渡(命名空间、输入输出、缺省参数、重载、引用、内联)
c语言·c++·学习
SL_staff1 小时前
JVS数字底座实践:构建企业级统一内容管理平台的技术路径
java·产品
nice_lcj5201 小时前
【从零理解 Spring AI · 12】MCP 的两种角色:做客户端还是做服务端
java·后端·spring·spring ai·ai应用开发
fengci.2 小时前
CTF2MISC中等部分
开发语言·前端·学习
桦说编程2 小时前
TransmittableThreadLocal 解读:从 CRR 机制到上下文所有权
java·后端·源码
xys_6783 小时前
JavaEE通关手册:初识Java
java·开发语言
文丑颜不良啊3 小时前
LeetCode2461~2480题目解析
java·leetcode
努力努力再努力wz3 小时前
【Lua 进阶系列】从 C++ 对象到 Lua 变量:一文理解 userdata、Lua 栈与元表绑定机制
c++·junit·lua