如何在 C++ 中写注释

在编写代码时，注释是一个重要的部分，它不仅可以帮助理解代码，还可以提高代码的可读性和可维护性。在 C++ 中，注释有两种方式：行注释和块注释。

行注释

行注释是以 // 开头的注释，这个注释符号后面的所有内容将被认为是注释，直到该行结束。

// 这是一个行注释
int a = 0; // 这是一条语句和一条行注释

块注释

块注释是以 /* 开头，以 */ 结尾的注释，这个注释符号之间的所有内容都被认为是注释。

/* 这是一个块注释 */
int b = 1; /* 这是一条语句和一条块注释 */

嵌套注释

在 C++ 中，不支持嵌套注释，也就是说，注释符号不能出现在另一个注释符号内部。

/* /* 这是一个嵌套的块注释，编译器将会提示错误 */ */

注释的用途

1. 解释代码的目的和设计思路。
2. 如果代码需要修改，让其他人了解你的思路和你何时做出这些修改。
3. 方便他人和自己回来找到和理解该代码。
4. 可以记录和说明代码中的缺陷和错误。

注释的样式

在 C++ 中可以使用多种注释样式，如：

文件头注释

文件头注释一般用来描述文件的内容、作者、时间等信息。

/*
 * @file: demo.cpp
 * @brief: This is a demo for C++ comments.
 * @author: User
 * @date: 2021-12-31
 */

函数注释

函数注释一般是用来解释函数的功能、参数、返回值等信息。

/*
 * @brief: This function adds two integers and returns their sum.
 * @param[in] a: First integer parameter.
 * @param[in] b: Second integer parameter.
 * @return Sum of a and b.
 */
int add(int a, int b){
    return a + b;
}

行内注释

行内注释一般出现在语句后面，以解释该语句的用途或者提供一些重要信息。

int count = 0; // 声明一个计数器变量，初始值为 0。

错误提示

当代码中出现了错误或者异常情况时，可以使用注释来描述该错误原因以及如何解决。

if (a == 0){
    // 如果 a 等于 0，将会导致除数为 0 的错误。
    return -1;
}
return b/a;

总结

注释对于代码的可读性和可维护性非常重要，因此我们要养成写注释的好习惯。在写注释的时候，要注意注释的内容要简明扼要、准确无误。