服务器之家:专注于服务器技术及软件下载分享
分类导航

PHP教程|ASP.NET教程|Java教程|ASP教程|编程技术|正则表达式|C/C++|IOS|C#|Swift|Android|VB|R语言|JavaScript|易语言|vb.net|

服务器之家 - 编程语言 - C/C++ - C语言中注释与注意事项的深入讲解

C语言中注释与注意事项的深入讲解

2021-12-27 15:09精致的灰(>_<) C/C++

在编写C语言源代码时,应该多使用注释,这样有助于对代码的理解,这篇文章主要给大家介绍了关于C语言中注释与注意事项的相关资料,需要的朋友可以参考下

C语言注释简介:

注释应该出现在三种位置

  • 文件头部
  • 函数头部
  • 函数体内的和代码混在一起的注释

对于文件头部的注释至少列出:

  • 版权声明、版本号、文件创建日期、作者、内容/功能、与其他文件的关系、修改日志等。

函数头部注释要求至少列出:

  • 函数功能、输入/输出参数、返回值、调用/被调用关系等。

C语言注释实例

注释在预编译阶段就会被删除掉,但是这里的删除并不是字面意义的删除,而是被替换,注释被替换,本质是替换成空格。

以下面的代码为例:

#include <stdio.h> 
int main() 
{ 
int /* */ i; //正确 
char *s = "abcdefgh   //hijklmn"; //正确 
//Is it a\
valid comment? //正确 
in/* */t j; //报错 
return 0; 
}

C语言中注释与注意事项的深入讲解

由于被替换成了空格,所以in t j这句话是无法编译的。

如果是C语言风格的注释出现了嵌套,则/*总是与离它最近的*/匹配,第二个/*并不会被认为是注释符号,因此第一个/*与第一个*/匹配,代码会剩下一个*/:

C语言中注释与注意事项的深入讲解

C语言中注释与注意事项的深入讲解

注释的一些注意事项

  1. 注释应当准确、易懂,反之有二义性。错误的注释容易产生误导,不利于代码维护。
  2. 边写代码边修改注释,修改代码的同时要修改对应的注释,保证注释和代码的一致性。不再有用的注释要及时删除。
  3. 注释是对代码的“提示”,所以注释应当简单明了,因为注释太多会让人眼花缭乱。
  4. 对于全局数据(全局变量、常量定义等)必须要加注释。注释清楚定义全局数据的目的。
  5. 注释的位置应该与被描述的代码相邻,可以与语句在同一行,也可以在语句的上一行,但不能在语句的下一行,因为这样不符合人的阅读习惯。
  6. 当代码比较长,特别是有多重嵌套时,应当在一些段落结束时加注释,便于阅读。
  7. 注释的缩进要与代码的缩进一致,这样代码会更美观,可读性强。
  8. 注释代码段时应当注重“为何做”而不是“怎么做”,要说明这段代码的操作意图。
  9. 数值的单位一定要注释。
  10. 对变量的范围给出注释,特别是参数。
  11. 对一系列的数字编号给出注释,尤其是在编写底层驱动的程序。
  12. 避免在一行代码或表达式的中间插入注释。
  13. 复杂的函数中,在分支语句、循环语句结束之后需要加注释,方便区分各分支或循环体。

总结

到此这篇关于C语言中注释与注意事项的文章就介绍到这了,更多相关C语言注释与注意事项内容请搜索服务器之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持服务器之家!

原文链接:https://blog.csdn.net/qq_52670477/article/details/120009186

延伸 · 阅读

精彩推荐
  • C/C++c++ 单线程实现同时监听多个端口

    c++ 单线程实现同时监听多个端口

    这篇文章主要介绍了c++ 单线程实现同时监听多个端口的方法,帮助大家更好的理解和学习使用c++,感兴趣的朋友可以了解下...

    源之缘11542021-10-27
  • C/C++深入理解goto语句的替代实现方式分析

    深入理解goto语句的替代实现方式分析

    本篇文章是对goto语句的替代实现方式进行了详细的分析介绍,需要的朋友参考下...

    C语言教程网7342020-12-03
  • C/C++C++之重载 重定义与重写用法详解

    C++之重载 重定义与重写用法详解

    这篇文章主要介绍了C++之重载 重定义与重写用法详解,本篇文章通过简要的案例,讲解了该项技术的了解与使用,以下就是详细内容,需要的朋友可以参考下...

    青山的青6062022-01-04
  • C/C++学习C++编程的必备软件

    学习C++编程的必备软件

    本文给大家分享的是作者在学习使用C++进行编程的时候所用到的一些常用的软件,这里推荐给大家...

    谢恩铭10102021-05-08
  • C/C++详解c语言中的 strcpy和strncpy字符串函数使用

    详解c语言中的 strcpy和strncpy字符串函数使用

    strcpy 和strcnpy函数是字符串复制函数。接下来通过本文给大家介绍c语言中的strcpy和strncpy字符串函数使用,感兴趣的朋友跟随小编要求看看吧...

    spring-go5642021-07-02
  • C/C++C语言实现电脑关机程序

    C语言实现电脑关机程序

    这篇文章主要为大家详细介绍了C语言实现电脑关机程序,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下...

    xiaocaidayong8482021-08-20
  • C/C++C语言中炫酷的文件操作实例详解

    C语言中炫酷的文件操作实例详解

    内存中的数据都是暂时的,当程序结束时,它们都将丢失,为了永久性的保存大量的数据,C语言提供了对文件的操作,这篇文章主要给大家介绍了关于C语言中文件...

    针眼_6702022-01-24
  • C/C++C/C++经典实例之模拟计算器示例代码

    C/C++经典实例之模拟计算器示例代码

    最近在看到的一个需求,本以为比较简单,但花了不少时间,所以下面这篇文章主要给大家介绍了关于C/C++经典实例之模拟计算器的相关资料,文中通过示...

    jia150610152021-06-07