代码注释规范化

最新推荐文章于 2024-06-25 22:00:00 发布

joy兜兜

最新推荐文章于 2024-06-25 22:00:00 发布

阅读量778

点赞数 2

分类专栏： C&C++学习笔记文章标签：编程基础常识注释规范性 C C++

本文为博主原创文章，未经博主允许不得转载。

本文链接：https://blog.csdn.net/qq_37591755/article/details/80669672

版权

C&C++学习笔记专栏收录该内容

11 篇文章 3 订阅

订阅专栏

代码使用过程中使用到注释是必要步骤，以下就几种注释以及其规范化进行讨论。

程序语言注释笔记：

一、注释的分类

C语言中注释方法有多种例如：//、/* */、#if 0等注释，下面就新手都使用过的//注释提出一些个人想法。

1.//注释，用于代码尾，优点是易于使用，编码时，简单的单行注释进行注释的时候，键盘的操作相对更为简单一点。在许多菜鸟到大佬的过度过程中都被使用到过，这种单行注释的风格被认为是从C++中引进的，但是单行注释在某些使用中（比如在C语言中）可能导致差异性或者BUG的产生。以下会使用到网络或书籍教材上比较经典的一些案例进行说明。

例1.0

#include<stdio.h>

#define PI 3.14

int main()

{

  inta,b,c;

 b=4;

 a=3;\

 c=b;

 printf("the is c:%.d.\n",c);

}

输出结果为：c=4

程序1.0输出截图1

上述程序中主要操作是给变量b赋予一个值4，再将b的值赋值给c，第七行属于冗余程序，对程序执行和操作结果无任何影响，可以删除或者注释屏蔽掉，输出结果应该都为：the is c:4,但是使用//注释符会出现一些错误。

#include<stdio.h>
#define PI 3.14
int main()
{
  int a,b,c;
  b=4;
  //a=3;\
  c=b;
  printf("the is c:%.d.\n",c);

}

可以看出程序输出结果为：the is c:1，那么为何程序的结果会与我们预期的不一样呢？这是因为在第七行代码末尾的\续行符的存在，此时使用//注释会让系统将下一行代码一同注释掉。导致上图的输出结果。虽然很多编辑器都具有对相对精准的判断给出提示比如DEVC给出颜色变化啥的，但是这种编码风格在新手过度阶段后应该放弃，后续使用符合代码注释规范的"/**/"注释符。