C语言多行注释用法介绍(必须知道的C语言知识细节)

本文将从多个方面详细阐述C语言中的多行注释

一、多行注释的基本语法

/*
多行注释的基本语法
*/

C语言中的多行注释以”/*”开头,以”*/”结尾,中间的部分就是注释内容。

多行注释在C语言程序中不会被编译器编译,编译器会直接忽略这些注释部分,从而不会对程序的执行产生任何影响。

二、多行注释的作用

多行注释可以用来描述代码的功能、用法、参数、限制、注意事项等内容,也可以用来暂时屏蔽掉某些代码块,方便程序员进行调试。

/*
函数名:add
功能:实现两个整数的加法运算
参数:
    x:int类型的整数
    y:int类型的整数
返回值:int类型的整数,表示x和y的和
限制:x和y的值不超过int类型所能表示的范围
*/
int add(int x, int y) {
    return x + y;
}

三、多行注释的嵌套

在多行注释中,可以使用另一对”/*”和”*/”注释符号来嵌套注释。

/*
这是外层注释
/*
这是内层注释
*/
*/

四、多行注释和单行注释的区别

在C语言程序中,还有单行注释以”//”开头的注释,和多行注释在语法上有一些区别。

单行注释只能注释单行代码,而多行注释可以注释多行代码;单行注释可以嵌套在多行注释中,但多行注释不能嵌套在单行注释中。

// 这是单行注释,注释掉一行代码
/*
这是多行注释,注释掉多行代码,
可以嵌套单行注释。
// 这是嵌套在多行注释中的单行注释
*/

五、多行注释的注意事项

在使用多行注释时,需要注意以下几个方面:

1.多行注释不能嵌套在字符串或字符常量中:

printf("这是一个 /* 错误的注释 */ 字符串");

2.多行注释不能跨行:

/* 这是正确的多行注释 */ 
/*
这也是正确的多行注释,
但是如果注释内容中有换行符会导致编译错误,
因为多行注释不能跨行。
*/

3.不要在代码中出现未关闭的多行注释:

/* 这是未关闭的多行注释
int a = 0;
*/

完整示例代码

#include <stdio.h>
/*
函数名:add
功能:实现两个整数的加法运算
参数:
    x:int类型的整数
    y:int类型的整数
返回值:int类型的整数,表示x和y的和
限制:x和y的值不超过int类型所能表示的范围
*/
int add(int x, int y) {
    return x + y;
}

int main() {
    /*
    这是一个多行注释,
    用来注释掉下面的代码,
    这些代码不会被编译执行。
    int a = 1;
    int b = 2;
    printf("%d + %d = %d", a, b, add(a, b));
    */
    printf("Hello Worldn"); // 这是一个单行注释
    return 0;
}

Published by

风君子

独自遨游何稽首 揭天掀地慰生平