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)

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

相关推荐
一个做软件开发的牛马6 分钟前
MyBatis-Plus 从零实战:完整搭建可运行 Demo,BaseMapper 零 SQL、Wrapper 条件构造、分页插件与代码生成器详解
java·后端
用户3721574261357 分钟前
Java 处理 PDF 图片:提取 PDF 中的图片,并压缩 PDF 图片体积
java
用户37215742613516 分钟前
Java 打印 Word 文档:从基础打印到高级设置
java
用户35218024547516 小时前
当 Prompt 学会"热更新":Spring Boot × Nacos3 AI 实战
java·spring boot·ai编程
东坡白菜19 小时前
破局全栈:一个前端开发的Java入门实战记录(1)
java·全栈
clint45619 小时前
C++进阶(1)——前景提要
c++
唐青枫19 小时前
Java Tomcat 实战指南:从 Servlet 容器到 Spring Boot 部署
java
wsaaaqqq20 小时前
roudan:自由选择实体、灵活操作数据、快速写入数据库的 Java 框架
java
夜悊1 天前
C++代码示例:进制数简单生成工具
c++
plainGeekDev1 天前
null 判断 → Kotlin 可空类型
android·java·kotlin