c语言 函数注释

- 1 - c语言函数头注释

C语言函数头注释是指在函数的定义之前，用注释的形式对该函数进行说明。它通常包括函数的名称、参数说明、返回值类型、函数功能、异常处理等信息。函数头注释的作用在于：

1. 方便代码维护。通过注释可以清晰地了解函数的功能和使用方式，减少后期维护的难度。

2. 提高代码可读性。函数头注释可以让代码更加易读易懂，降低开发者的学习成本。

3. 保证代码质量。函数头注释可以让开发者更加注重函数的设计和实现，从而提高代码质量。

在编写函数头注释时，应该注意以下几点：

1. 函数名称应该简洁、具有描述性。

2. 参数说明应该详细，包括参数名称、类型、作用等信息。

3. 返回值类型应该明确，说明返回值的类型和意义。

4. 函数功能应该简洁明了，用少量的语言描述函数的作用。

5. 异常处理应该说明可能出现的异常情况，并提供相应的解决方案。

总之，在编写C语言代码时，应该注重注释的编写，尤其是函数头注释，以便于后期的维护和代码优化。

C语⾔注释符号

同学们认为注释很简单，那我来看看下⾯的代码是否正确？

1.似是⽽⾮的问题

1 int main()

2 {

3 int/*...*/i;

4 char* s = "abcdefgh //hijklmn";

5 //Is it a \ //

6 valid comment?

7 in/*...*/t i;

8 return 0;

9

10 }

你的答案是什么呢?

答案：

只有第七⾏出错。

2.注释规则

编译器在编译过程中使⽤空格替换整个注释

字符串字符串字⾯量中的 // 和 /*...*/不代表注释符号

/*......*/型注释不能被嵌套（在分段排除异常往往被忽略）

3.有趣的问题

你觉得y=x/*p是什么意思？

作者本意：

把x除以*p的结果赋值给y。

编译器：

将/*作为⼀段注释的开始，把/* 后⾯的内容都当成注释内容，直到*/出现为⽌。

在编译器看来，注释和其它程序元素是平等的，因此，作为⼯程师不能轻视注释,可以⽤x/ *p表⽰（空格的重要性）

（1）、教科书式注释：

1 r = n / 2; //r是n的⼀半

2 while( ( r - n / r ) <= t) //循环，仅当r-n/r不⼤于t

3 {

4

5 }

6 r=r+n*t; //对变量r进⾏赋值

7

8 n++; //变量n⾃增1

注释⽤于阐述原因和意图⽽不是描述程序的运⾏过程！上⾯的注释⼀点⽤都没有

（2）、迷惑型注释：

1 init();

2

3 //......

4

5 sad = 0x723; //R.I.P.L.V.B.

6

7 //......

8

9 finalize();

解释：Rest in piece , Ludwig Van Benthoven， 0x723(16)=1827(10) 原作者看到这⾏代码，怀恋贝多芬！！

写注释不是晒⼼情，必须⽆⼆义性，起到对代码进⾏提⽰的作⽤，避免使⽤缩写（3）、忽悠型注释：

1 // ... ...

c语言 函数注释

函数注释是编程中非常重要的一部分，它能够帮助其他开发者理解函数的作用、参数要求以及返回值等信息。在C语言中，函数注释通常使用特定的格式进行书写，以确保注释的清晰易读。本文将介绍C语言函数注释的格式要求以及如何编写规范的函数注释。

一、函数注释的格式要求

在C语言中，函数注释通常位于函数声明之前，使用特定的注释格式进行书写。以下是常用的函数注释格式要求：

1. 函数注释以"/**"开始，以"*/"结束，中间的内容为注释的具体描述。

2. 注释的第一行为函数的摘要描述，简明扼要地说明函数的功能。

3. 注释的后续行为详细描述，可以包括函数的参数说明、返回值说明、异常情况说明等。

4. 参数说明应包括参数的名称、类型、作用、是否可以为空等信息。

5. 返回值说明应说明函数的返回值类型、返回值的作用、取值范围等信息。

6. 异常情况说明应说明函数可能出现的异常情况以及如何处理。

7. 注释中可以使用合适的标点符号、缩进、换行等方式使注释更易读。

二、编写规范的函数注释

1. 函数摘要描述：函数的摘要描述应简明扼要地说明函数的功能。例如，对于一个计算两个数之和的函数，可以使用以下方式进行摘要描述：

/**

* 计算两个数的和

*/

2. 参数说明：参数说明应包括参数的名称、类型、作用、是否可以为空等信息。例如，对于一个计算两个数之和的函数，可以使用以下方式进行参数说明：

/**

* 计算两个数的和

*

* @param num1 第一个操作数

* @param num2 第二个操作数

*

* @return 两个数的和

*/

3. 返回值说明：返回值说明应说明函数的返回值类型、返回值的作用、取值范围等信息。例如，对于一个计算两个数之和的函数，可以使用以下方式进行返回值说明：

/**

* 计算两个数的和

*

* @param num1 第一个操作数

* @param num2 第二个操作数

c语言中注释的快捷键

C语言中注释的快捷键

注释是程序中的一种特殊文本，用于对代码进行解释、补充说明或临时禁用。在C语言中，注释可以提高代码的可读性和可维护性。为了提高开发效率，许多代码编辑器和集成开发环境（IDE）都提供了注释的快捷键，使开发者能够方便地插入注释标记。下面将介绍一些常见的C语言注释快捷键及其用法。

1. 单行注释快捷键

在C语言中，可以使用双斜杠（//）来插入单行注释。单行注释用于对代码进行简单的解释或说明。在大多数代码编辑器中，可以使用Ctrl + / 或Ctrl + ? 快捷键来插入单行注释。例如：

```c

// 这是一个单行注释

```

2. 块注释快捷键

块注释也称为多行注释，用于对一段代码进行详细的解释。块注释以/*开头，以*/结尾。在大多数代码编辑器中，可以使用Ctrl +

Shift + / 或Ctrl + Shift + ? 快捷键来插入块注释。例如：

```c /*

这是一个块注释

可以跨越多行

*/

```

3. 快速注释/取消注释快捷键

在开发过程中，有时需要快速注释或取消注释一段代码。注释快捷键可以帮助我们快速完成这个任务。在大多数代码编辑器中，可以使用Ctrl + / 或Ctrl + Shift + / 快捷键来快速注释或取消注释选定的代码。例如：

```c

// printf("Hello, World!");

/*

printf("Hello, World!");

*/

4. 文档注释快捷键

文档注释用于生成代码文档，对函数、类、结构体等进行详细的说明。在C语言中，常用的文档注释格式是基于Doxygen的风格。在大多数代码编辑器中，可以使用特定的快捷键来插入文档注释模板。例如：

```c

/**

* @brief 函数简要说明

*

* 函数详细说明

*

* @param 参数名 参数说明

* @return 返回值说明

*/

```