C语言注释方法有几种
更新时间:2023-07-101. 单行注释
C语言中单行注释是用“//”符号表示,它的作用是在代码中添加注释信息,以方便其它人阅读代码或者作为自己日后查找错误的记录。单行注释只能放在一行代码的后面。
#include <stdio.h> int main(){ int a=5, b=3; int sum=a+b; //计算两个整数的和 printf("sum=%d",sum); //输出和 return 0; }
2. 多行注释
在C语言中,多行注释也被称为块注释,它的作用是提供一种方法,以便在代码中添加注释块。多行注释可以跨越多行代码,视情况而定,不同的编译器可能对多行注释的长度有不同的限制。多行注释以“/*”开始,以“*/”结束。
#include <stdio.h> int main(){ /* 这是一个简单的加法程序 程序计算5和3的和 */ int a=5, b=3; int sum=a+b; //计算两个整数的和 printf("sum=%d",sum); //输出和 return 0; }
3. 特殊注释
C语言中存在一些特殊注释形式,它们的作用不同于单行注释和多行注释。例如:文件头注释、函数注释、变量注释等等。特殊注释有助于我们更清晰地理解代码中变量或函数的作用和含义。
// 文件头注释 /******************************* 这是一个简单的加法程序 ********************************/ // 函数注释 /* 函数名称:add 函数功能:计算两个整数的和 输入参数:a,b 返回值:两个整数的和 */ int add(int a, int b){ return a+b; } // 变量注释 int a=5; //被加数 int b=3; //加数
4. 文档注释
与特殊注释类似,文档注释是特定格式的注释,以提供分析器或文档生成器的信息。文档注释通常用于生成API文档和其他文档。文档注释以“/**”开始,以“*/”结束。
/** * @file main.c * @brief 这是一个简单的加法程序 * * 这个程序有两个整数相加的功能,它由函数add实现, * calculate_sum函数用于计算两个整数的和并进行输出, * 其中用到了add函数。 * @date 2020-01-01 */ /** * @brief 计算两个整数的和并进行输出 * * 输入两个整数,将它们相加并输出结果。 * @param a 第一个被加数 * @param b 第二个加数 * @return 和 */ int calculate_sum(int a, int b){ int sum = add(a, b); printf("%d + %d = %d", a, b, sum); return sum; } /** * @brief 计算两个整数的和 * * @param a 第一个被加数 * @param b 第二个加数 * @return int 两个整数的和 */ int add(int a, int b){ return a+b; }