在 C 语言中,为一些关键代码注释是非常有必要的。注释的好处很多,比如方便理解、方便查找或方便团队其他开发人员了解你的代码,而且也方便以后你对自己的代码进行修改。
C 单行注释
在 C 语言中,当注释的内容比较少,只有一行时,我们可以使用单行注释的方式。
语法:
// 单行注释说明:
在使用 C 语言单行注释时,比较好的一个规范是:“//” 与注释内容之间有一个空格。虽然没有这个空格也没问题,不过加上空格会更加直观规范一些。
提示: // 风格的单行注释是从 C++ 引入的,现代 C 编译器(C99 及更新标准)都支持。不过在一些较老的 C 标准中,可能只支持多行注释。
示例 1:使用 C 单行注释
#include <stdio.h>
int main(void)
{
int a = 10; // 定义第1个整数
int b = 20; // 定义第2个整数
int sum = a + b; // 计算两数之和
printf("%d", sum); // 打印结果
return 0;
}运行结果如下。
30分析:
注释的内容是给我们开发者看的,而不是给计算机看的。当我们对代码进行编译时,编译器会直接忽略注释的内容。对于注释的内容,不会影响代码的执行,也不会在终端窗口输出出来。
C 多行注释
在 C 语言中,当注释的内容比较多,用一行表达不出来时,我们可以使用多行注释的方式。
语法:
/*
多行注释
多行注释
多行注释
*/说明:
C 语言的多行注释以 “/*” 开头,并以 “*/” 结尾,中间可以包含多行内容。
注意: 在 C 语言标准中,多行注释 /* ... */ 是不允许嵌套使用的。也就是说,你不能在一个多行注释内部再放置另一个多行注释。如果尝试嵌套多行注释,可能会导致编译器报错或产生意想不到的结果。
示例 2:使用 C 多行注释
#include <stdio.h>
/*
这是一个计算两个整数之和的程序。
程序首先定义了两个整数变量 a 和 b,
然后计算它们的和,最后将结果打印出来。
*/
int main(void)
{
int a = 10;
int b = 20;
int sum = a + b;
printf("%d\n", sum);
return 0;
}运行结果如下。
30分析:
当然了,如果注释的内容只有一行,我们也可以使用多行注释的方式,比如:
#include <stdio.h>
int main(void)
{
int a = 10; /* 定义第1个整数 */
int b = 20; /* 定义第2个整数 */
int sum = a + b; /* 计算两数之和 */
printf("%d", sum); /* 输出结果 */
return 0;
}提示: 在 C 语言中,虽然 “/* */” 也可以用于单行注释,但并不推荐这样去做。对于单行注释,更加推荐使用 “//” 来实现。
