C / C++ 中的注释

Question

记录良好的程序作为程序员是一种好习惯。它使程序更具可读性，并且更容易发现错误。好的文档的重要组成部分是注释。

• 在计算机编程中，注释是计算机程序源代码中程序员可读的解释或注释。
• 注释是不由编译器和解释器执行的语句。

在 C / C++中，有两种类型的注释：

1. 单行注释
2. 多行评论

单行注释

表示为 // 双正斜杠
它用于表示单行注释。它将注释仅应用于一行。由于它最初是 C++编程的一部分，因此被称为 C++样式的注释。
例如：

// single line comment

示例： 对于 C 和 C++，此示例相同，因为两种语言的注释风格均相同。

C

// C program to illustrate
// use of multi-line comment
#include 
int main(void)
{
 
    // Single line Welcome user comment
    printf("Welcome to GeeksforGeeks");
    return 0;
}

---

C

/* C program to illustrate
use of
multi-line comment */
#include 
int main(void)
{
 
    /* Multi-line Welcome user comment
    written to demonstrate comments
    in C/C++ */
    printf("Welcome to GeeksforGeeks");
    return 0;
}

---

输出：

Welcome to GeeksforGeeks

多行评论

表示为 / * any_text * /， 以正斜杠和星号(/ *) 开头，以星号和正斜杠(* /) 结束。
它用于表示多行注释。它可以将注释应用于多个行。它是在 C 编程中引入的，称为 C-Style 注释。

/*Comment starts
continues
continues
.
.
.
Comment ends*/

示例： 对于 C 和 C++，此示例相同，因为两种语言的注释风格均相同。

C

/* C program to illustrate
use of
multi-line comment */
#include 
int main(void)
{
 
    /* Multi-line Welcome user comment
    written to demonstrate comments
    in C/C++ */
    printf("Welcome to GeeksforGeeks");
    return 0;
}

输出：

Welcome to GeeksforGeeks

代码行末尾的注释

您还可以创建一个注释，该注释显示在代码行的末尾。但是通常，将注释放在代码行之前是一种更好的做法。
示例： 对于 C 和 C++，此示例相同，因为两种语言的注释风格均相同。

int age; // age of the person

何时以及为何在编程中使用注释?

1. 如果未提供有关程序详细信息的注释，则阅读大型代码的人员将感到困惑。
2. 注释是一种通过提供更多描述来使代码更具可读性的方法。
3. 注释可以包括使代码易于理解的算法描述。
4. 如果要在很长一段时间后重用代码，则注释也可以对自己有所帮助。