基于linux平台的C语言入门教程（3）代码注释

1. 什么是注释？

注释是程序中用于解释代码的文本，编译器会忽略注释内容。注释的作用是提高代码的可读性，帮助开发者理解代码的功能和逻辑。

2. C 语言中的注释类型

C 语言支持两种注释方式：

1. 单行注释：以 // 开头，注释内容直到行尾。
2. 多行注释：以 /* 开头，以 */ 结尾，可以跨越多行。

3. 单行注释

单行注释用于注释一行代码或简短的解释。语法如下：

// 这是单行注释

例如：

int age = 25;  // 声明并初始化变量 age

4. 多行注释

多行注释用于注释多行代码或详细的解释。语法如下：

/*
这是多行注释
可以跨越多行
*/

例如：

/*
这是一个计算圆面积的程序
作者：AI助手
日期：2023-10-10
*/
#include <stdio.h>

int main() {
    int radius = 5;
    const double area = 3.14159 * radius * radius;
    printf("面积: %.2f\n", area);
    return 0;
}

5. 注释的使用场景

1. 解释代码功能：在复杂的代码段前添加注释，解释其功能。
2. 标记待办事项：使用注释标记需要后续处理的部分。
3. 调试代码：暂时注释掉部分代码，以便调试。

6. 示例代码

以下是一个使用注释的示例程序：

#include <stdio.h>

/*
这是一个简单的 C 语言程序
用于计算两个数的和
*/
int main() {
    int num1 = 10;  // 定义第一个数
    int num2 = 20;  // 定义第二个数
    int sum = num1 + num2;  // 计算和

    // 输出结果
    printf("和: %d\n", sum);

    return 0;
}

代码解析：

1. 多行注释：

   • 在程序开头添加了多行注释，描述程序的功能。

2. 单行注释：

   • 在变量声明和计算部分添加了单行注释，解释代码的作用。

3. 输出结果：

   • 使用 printf 输出计算结果。

输出结果：

和: 30

7. 常见问题

问题 1：注释会影响程序性能吗？

• 不会。注释在编译时会被忽略，不会影响程序的性能。

问题 2：注释可以嵌套吗？

• 单行注释不能嵌套，多行注释可以嵌套，但不推荐使用嵌套注释。

问题 3：注释应该写什么内容？

• 注释应简洁明了，解释代码的功能、逻辑或特殊处理，避免无意义的注释。

8. 扩展练习

1. 在程序中添加注释，解释每一行代码的作用。
2. 尝试使用多行注释注释掉一段代码，观察程序运行结果。
3. 编写一个程序，计算两个数的乘积，并添加适当的注释。