C++注释 详解

注释是编程语言一个重要组成部分,合理使用注释可以使C++代码更加清晰易读。

一、单行注释

单行注释使用两个斜杠//,该行余下内容都是注释:

// 这是一个单行注释
int a = 1; // 定义变量a

可以在代码后面新增说明。

二、多行注释

多行注释使用/* 和 */括起来:

/* 这是一个
多行注释的示例 */

多行注释适合用于描述功能模块等。

三、文档注释

文档注释可以生成代码文档:

/**
* @brief 计算两数之和
* 
* @param a 整数a
* @param b 整数b
* @return 两数之和
*/
int sum(int a, int b) {
  return a + b;
}

可以由Doxygen等工具解析文档注释。

四、注释代码

可以使用注释临时屏蔽某段代码:

void func() 
{
  // int a = 1;

  // 下面代码暂不需要

  /*
  int b = 2;
  cout << b << endl;
  */
}

五、标记说明

使用注释标记说明代码的重要部分:

// 下面实现排序算法

六、TODO注释

标记代码中计划实现的功能:

// TODO:实现错误处理

综上,注释可以极大提高代码可读性,是一个合格C++程序员必须掌握的技能。