c语言注释

最新推荐文章于 2024-03-12 20:54:06 发布

鱼生肥

最新推荐文章于 2024-03-12 20:54:06 发布

阅读量223

点赞数

文章标签： c语言开发语言

本文链接：https://blog.csdn.net/weixin_74550857/article/details/131862073

版权

注释

注释是为了程序员维护代码而出现的。注释内容其本身并不参与程序的编译与执行，注释的出现只是为了记录一些文本信息而出现的。注释分为单行注释和多行注释。

单行注释

将注释放在双斜杠//后面，从双斜杠到行尾都属于注释。
单行注释可以放在首行，也可以放在一行语句的行尾。

//这是一行注释
int a; //这也是一行注释

多行注释

将注释放在/* */之间，内部也可以分行。

/* 注释*/

/*
这是一行注释
*/

这种注释可以插在行内，对函数参数进行说明，跟在它后面的代码依然会有效执行。

int fopen(char s/*file name*/,int mode);

编译时注释会被替换成一个空格，所以int/*注释*/a会被替换成int a,而不是inta。

多行注释不能嵌套使用，/*开始注释后，遇到第一个*/就结束了。

/*
这是一行注释
/*
这是一行注释
*/
这是一行注释

确定要放弃本次机会？

福利倒计时

: :

立减 ¥

普通VIP年卡可用

立即使用

鱼生肥

关注关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
1
评论
分享

复制链接

分享到 QQ

分享到新浪微博

扫一扫
举报

举报

C语言注释方法有多种形式

PkbgRuby的博客

09-25

1090

注释是编程中非常重要的一部分，它可以增加代码的可读性、可维护性和可理解性。在C语言中，有三种常见的注释方法：单行注释、多行注释和特殊注释。这些是C语言中常用的注释方法。注释对于代码的可读性和可维护性非常重要，因此在编写代码时应该养成良好的注释习惯。

c语言注释含义,C语言编程规范——注释

weixin_40009393的博客

05-19

1825

前言制定C语言的编程规范，对代码的清晰、简洁、可测试、安全、程序效率、可移植各个方面有巨大的作用。良好的注释能让整个代码读起来更加流畅，此乃程序猿出差旅行，通宵熬夜必备良药......注释的原则注释的目的是解释代码的目的、功能和采用的方法，提供代码以外的信息，帮助读者理解代码，防止没必要的重复注释信息。示例：如下注释意义不大。/* if receive_flag is TRUE */if (re...

1 条评论您还未登录，请先登录后发表或查看评论

C语言 ——注释

m0_73299799的博客

03-12

1298

语法：// 待注释的内容- 位置：可放在代码后，称之为行尾注释；也可放代码上一行，称作行上注释。```c// 这是单行注释文字```

javadoc 标签

Whtai_的博客

08-27

1758

javadoc 标签 javadoc 工具软件识别以下标签：标签描述示例 @author 标识一个类的作者 @author description @deprecated 指名一个过期的类或成员 @deprecated description {@docRoot} 指明当前文档根目录的路径 Directory Path @exception 标志一个类抛出的异常 @exception exception-name explanation {@inheritDoc} 从直

Java注释/*和/**的区别

雪落南城的博客

03-05

1万+

Java注释的三种类型 1、单选注释：符号是：// 2、块注释：符号是： /* */ 可以跨多行 3、javadoc注释：符号是： /** */ 可以跨多行，生成javadoc时，这样的注释会被生成标准的javaapi注释。 /** */注释的话，你在调用类和方法的时候会出现提示，内容就是你写的注释。而/* */就没有了。/* */就是//的多行版 ...

【Java基础】三种注释

qq_64976935的博客

03-04

2533

一：注释在编写程序时,为了使代码易于阅读，通常会在实现功能的同时为代码添加一些注释。注释是对程序的某个功能或者某行代码的解释说明，它能够让开发者在后期阅读和使用代码时能更容易理解代码的作用。注释内容不会被编译注释分为三种 1：单行注释（“//”） eg: int a = 10; //定义一个整型变量a 2:多行注释（“/* ------------*/”） eg: /*定义一个整型变量x 将5赋值给变量x*/ int x; x = 5; 3:文档注释文档注释通常是对程序

java中的注释_Java注释中的/ **和/ *

weixin_42398171的博客

02-21

1232

小编典典第一种形式称为Javadoc。在为javadoc工具编写由程序生成的正式API时，可以使用此功能。例如，Java7 API页面使用Javadoc并由该工具生成。您将在Javadoc中看到的一些常见元素包括：@param：用于指示将哪些参数传递给方法，以及它们应具有的值@return：用于指示该方法将返回的结果@throws：用于指示在某些输入的情况下方法抛出异常或错误@since：用于表示...

C语言注释规范.pdf

11-21

C语言注释规范在软件开发项目中，代码注释的重要性不言而喻。良好的代码注释可以提高代码的可读性、维护性和可重用性。本文将详细介绍C语言注释规范，包括注释原则、文件头部的注释、结构体和全局变量的注释、函数...

实现去除c语言注释的小工具

09-04

本篇文章将详细介绍如何实现一个去除C语言注释的小工具，以及它如何处理不同类型的注释。 1. **单行注释**：C语言的单行注释以两个正斜杠`//`开始，直到行尾。在实现去除注释的工具时，当遇到`//`开始的序列，我们...

一个C语言注释转换的小项目.zip

06-14

这个"一个C语言注释转换的小项目"显然旨在帮助新手熟悉这一概念。单行注释以两个正斜杠（//）开始，直到行末的所有内容都被视为注释。例如： ```c // 这是一个单行注释，用于解释接下来的代码功能 int main() { /...

c语言怎么添加注析,大家都知道C语言中的/* */注释，这种注释有什么致命的问题?...

weixin_42421187的博客

05-21

909

满意答案whrdpt2013.11.05采纳率：55%等级：11已帮助：7765人/*……*/,这种注释是C语言程序中对一大段连续的程序段进行注释的标记符，在规范的C程序中也常常用来标示版权、著作者、调试运行信息、函数输入输出变量等，但都是利用其注释的作用。另外，很多程序员善于利用它的注释作用将某特定的程序段注释掉(不编译)，来对程序进行调试。对单独或者小段的程序段加以注解时使用“//”更...

Java中 /** */注释和 /* */注释的区别

太匆匆

12-09

7935

/**......*/ 注释若干行，并写入javadoc文档。每个文档注释都会被置于注释定界符注释文档将用来生成HTML格式的代码报告，所以注释文档必须书写在类、域、构造函数、方法，以及字段(field)定义之前。注释文档由两部分组成——描述、块标记。你再调用类和方法的时候会出现提示，内容就是你写的注释。就好像文档帮助一样。类似"字符串".toString()，鼠标放在toStri

注释

jdnicky的博客

06-05

575

XML： html： java(class,js)：单行注释：//这里是java注释块注释： /* 这里是java注释 */ 文档注释：文档注释一般用于方法或类上 ...

html——注释（单行注释多行注释）

最新发布

03-29

<think>好的，我现在需要回答用户关于C语言注释风格和正确使用的问题。首先，用户提到了C语言的单行注释、多行注释、注释规范和编码标准。根据提供的引用内容，我需要结合这些信息来组织回答。首先，我应该确认C语言支持的注释类型。C语言传统上使用`/* ... */`作为多行注释，而C99标准之后引入了`//`单行注释。这一点需要明确说明，可能用户混淆了不同版本的C标准，所以需要指出不同标准的支持情况。接下来，关于单行注释的使用规范。根据引用[2]中的Python示例，单行注释通常用于简短说明，C#的引用[1]和[3]也提到了代码规范，比如注释的位置和内容。虽然引用是C#和Python的，但通用的注释规范类似，比如注释应放在代码上方或行尾，内容简洁明确。需要将这些通用规范应用到C语言的单行注释中，比如使用`//`，并建议每行注释不宜过长。然后是多行注释，C语言使用`/* ... */`，需要注意嵌套问题，因为C不允许嵌套多行注释。这点很重要，用户可能会遇到嵌套注释导致的错误，需要特别提醒。同时，多行注释常用于函数说明或复杂逻辑的解释，可以结合引用中的例子，比如函数头的描述或算法步骤。注释规范部分，需要强调一致性和可读性。比如注释与代码的缩进对齐，避免无用注释，使用中文或英文的统一。引用[1]中提到了C#的命名规范和代码结构，虽然语言不同，但规范原则相通，可以借鉴其思想，比如注释应清晰帮助理解代码，而不是重复代码。编码标准方面，引用[1]和[3]提到了使用`int`而非无符号类型，以及数组初始化的简洁语法。虽然这些是C#的例子，但可以引申到C语言的编码习惯，比如注释应遵循项目或团队的规范，保持一致性。可能还需要提到工具支持，如Doxygen用于生成文档，这与注释风格相关。然后根据用户提供的引用内容，虽然主要是C#和Python的例子，但可以指出不同语言的注释风格差异，帮助用户区分。例如，C的注释与Python的三引号不同，避免用户混淆。最后生成相关问题，需要围绕C语言的注释展开，比如不同标准的支持、嵌套注释的问题、编码规范建议、工具支持等。确保问题覆盖回答中的关键点，帮助用户进一步学习。在整理结构时，需要分点清晰，先介绍两种注释语法，再讲使用场景，然后规范建议，最后编码标准。注意使用正确的LaTeX格式，行内注释用`$...$`，但可能这里不需要数学公式，所以主要关注代码块和段落结构。确保代码示例正确，比如展示单行和多行注释的例子，避免语法错误。可能需要注意用户提供的引用中，引用[2]提到了中文编码声明注释，这在C语言中通常是用`/* ... */`或`//`，但需要确认是否适用。不过C语言源文件的编码声明通常是在文件开头用注释标明，比如`// -*- coding: utf-8 -*-`，但这不是C标准的一部分，可能依赖编译器。这部分如果用户提到，可能需要说明，但用户的问题可能更关注一般注释，所以可以略过，除非有直接关联。总结步骤： 1. 确定C语言支持的注释类型及版本差异。 2. 分别说明单行和多行注释的语法和使用场景。 3. 提供注释规范，如位置、内容、一致性。 4. 编码标准建议，如团队规范、工具集成。 5. 示例代码展示正确用法。 6. 生成相关问题。需要检查是否有遗漏点，比如注释的嵌套问题、常见错误，以及如何避免。确保回答准确，参考提供的引用内容中的规范思想，即使例子来自其他语言，但通用原则适用。</think>### C语言注释风格及使用规范 #### 1. **注释类型** C语言支持两种注释风格： - **单行注释**：使用 `//` 符号，从 `//` 开始到行尾的内容均为注释。此语法在 **C99标准** 及之后的版本中正式支持[^1]。 **示例**： ```c int x = 10; // 初始化变量x为10 ``` - **多行注释**：使用 `/* ... */` 符号包裹注释内容，适用于跨行或代码块旁的说明。 **示例**： ```c /* 计算圆的面积：公式为 π*r² */ float area = 3.14 * r * r; ``` #### 2. **使用场景** - **单行注释**： - 简短说明变量含义、代码意图。 - 临时禁用单行代码（如调试时）。 ```c // 以下循环用于累加数组元素 for (int i=0; i<n; i++) sum += arr[i]; ``` - **多行注释**： - 描述函数功能、参数及返回值。 - 解释复杂算法或代码段逻辑。 ```c /* 快速排序函数 @param arr 待排序数组 @param low 起始索引 @param high 结束索引 */ void quick_sort(int arr[], int low, int high); ``` #### 3. **注释规范** - **内容清晰**：避免无意义的注释（如`i++; // i自增`），应说明“为什么”而非“是什么”[^1]。 - **格式对齐**：注释与代码缩进一致，增强可读性。 ```c if (x > 100) { // 处理异常值 x = normalize(x); } ``` - **避免嵌套**：`/* ... */` 不支持嵌套，否则会导致编译错误[^3]。 ```c /* 外层注释 /* 内层注释 */ */ // 错误！内层注释闭合后，外层注释提前结束 ``` #### 4. **编码标准建议** - **团队统一**：遵循项目或团队的注释规范（如Doxygen格式生成文档）。 ```c /** @brief 计算两数之和 */ int add(int a, int b) { return a + b; } ``` - **工具集成**：使用静态分析工具（如Clang-Tidy）检查注释一致性。 #### 示例代码 ```c // 主函数：程序入口 #include <stdio.h> /* 交换两个整数值 @param a 第一个数的指针 @param b 第二个数的指针 */ void swap(int *a, int *b) { int temp = *a; *a = *b; *b = temp; } int main() { int x = 5, y = 10; swap(&x, &y); // 调用交换函数 return 0; } ```