课程简介
注释
在之前的教程中,你学习了如何编写你的第一个 C 程序。现在,让我们来学习 C 语言中的注释。
提示:我们在这个教程系列中早早地介绍注释,是因为从现在开始,我们将使用注释来解释我们的代码。
注释是我们添加到代码中的提示,使其更容易理解。C 编译器会完全忽略注释。
例如,
#include <stdio.h>
int main() {
// 打印 Hello World 到屏幕上
printf("Hello World");
return 0;
}
输出
Hello World
在这里,// 打印 Hello World 到屏幕上
是 C 语言中的注释。C 编译器会忽略 //
符号后的所有内容。
注意:你可以忽略编程概念,专注于注释。我们会在以后的教程中重新讨论这些概念。
单行注释
在 C 语言中,单行注释以 //
符号开始,并且始于同一行并在该行结束。例如,
#include <stdio.h>
int main() {
// 创建整数变量
int age = 25;
// 打印年龄变量
printf("年龄: %d", age);
return 0;
}
输出
年龄: 25
在上述示例中,我们使用了两个单行注释:
// 创建整数变量
// 打印年龄变量
我们还可以将单行注释与代码一起使用。
int age = 25; // 创建整数变量
在这里,//
前的代码会被执行,而 //
后的代码会被编译器忽略。
多行注释
在 C 编程中,还有另一种注释类型,允许我们一次注释多行内容,这就是多行注释。
要编写多行注释,我们使用 /*....*/
符号。例如,
/* 这个程序从用户那里获取年龄输入
它将其存储在 age 变量中
并使用 printf() 打印值 */
#include <stdio.h>
int main() {
// 创建整数变量
int age = 25;
// 打印年龄变量
printf("年龄: %d", age);
return 0;
}
输出
年龄: 25
在这种类型的注释中,C 编译器会忽略从 /*
到 */
之间的所有内容。
注意:记住使用注释的快捷键:
- 单行注释:
Ctrl + /
(Windows)和Cmd + /
(Mac) - 多行注释:
Ctrl + Shift + /
(Windows)和Cmd + Shift + /
(Mac)
使用注释来防止代码执行
在调试过程中,有时我们不希望某些代码片段执行。例如,
#include <stdio.h>
int main() {
int number1 = 10;
int number2 = 15;
int sum = number1 + number2;
printf("和是: %d\n", sum);
printf("积是: %d\n", product);
return 0;
}
在这里,代码抛出了一个错误,因为我们没有定义 product
变量。
我们可以将导致错误的代码注释掉。
例如,
#include <stdio.h>
int main() {
int number1 = 10;
int number2 = 15;
int sum = number1 + number2;
printf("和是: %d\n", sum);
// printf("积是: %d\n", product);
return 0;
}
现在,代码可以正常运行而不会出现错误。
在这里,我们通过注释掉与 product
相关的代码解决了错误。
如果我们将来需要计算积,我们可以取消注释这部分代码。
为什么使用注释?
我们应该使用注释的原因包括:
- 注释使我们的代码对未来的参考变得更具可读性。
- 注释用于调试目的。
- 我们可以使用注释进行代码协作,因为它帮助其他开发者理解我们的代码。
注意:注释不能也不应该作为解释编写不良代码的替代品。总是尽量编写干净、易于理解的代码,然后使用注释作为补充。
在大多数情况下,总是使用注释来解释“为什么”而不是“如何”,这样你就可以了。