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)

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

相关推荐
IKUN家族7 小时前
Spring MVC(一)
java·spring·mvc
code_pgf8 小时前
C++11 / C++14 / C++17 / C++20 新特性总结
c++·c++20
老马识途2.08 小时前
关于跨域问题的总结
java·前端
魔力女仆9 小时前
分享一个 JS 鼠标跟随贪吃蛇背景库
开发语言·javascript·计算机外设
都叫我大帅哥9 小时前
Java日期时间三十年战争:从Date考古到LocalDateTime革命,以及数据库与前端的那点事儿
java
Muscleheng9 小时前
SpringBoot 集成 DeepSeek 实现 RAG 文档问答
java·spring boot·ai·springai
2401_8949155310 小时前
GEO 搜索优化完整源码从零部署:环境配置、集群搭建全流程
开发语言·python·tcp/ip·算法·unity
2501_9364156910 小时前
可变参数&综合练习&斗地主游戏
java·windows·游戏
麻瓜老宋10 小时前
AI开发C语言应用按步走,表达式计算器calc的第二十二步,分号赋值链式修复、TOKEN_ASSIGN
c语言·开发语言·atomcode
极客先躯11 小时前
高级java每日一道面试题-2026年05月03日-实战篇[Docker]-如何实现容器化环境的数据加密?
java·运维·docker·容器·金融·加解密·高级面试