代码注释规范化

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

程序语言注释笔记：

一、注释的分类

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给出颜色变化啥的，但是这种编码风格在新手过度阶段后应该放弃，后续使用符合代码注释规范的"/**/"注释符。

二、注释规范

在菜鸟过度到大佬之后都会形成自己的编码风格，其中职场中的代码规范性影响甚大，以下只浅薄介绍以下C语言的规范注释风格。

1.源程序中的有效注释须占到代码总量的百分之20以上。

2.文件头部需进行注释，注释须包括版权说明、版本号、生成日期、作者、内容、功能、修改日志等。

3.函数头部应进行注释，列出：函数的目的/功能、输入参数、输出参数、返回值、调用关系（函数、表）等。

4.注释应与其描述的代码相近，对代码的注释应放在其上方或右方（对单条语句的注释）相邻位置，不可放在下面，如放于上方则需与其上面的代码用空行隔开。

5.对于所有有物理含义的变量、常量，如果其命名不是充分自注释的，在声明时都必须加以注释，说明其物理含义。

6.避免在一行代码或表达式的中间插入注释。

7.注释格式尽量统一，建议使用“/* …… */”。

8.注释应考虑程序易读及外观排版的因素，使用的语言若是中、英兼有的，建议多使用中文，除非能用非常流利准确的英文表达。

9.数据结构声明(包括数组、结构、类、枚举等)，如果其命名不是充分自注释的，必须加以注释。对数据结构的注释应放在其上方相邻位置，不可放在下面；对结构中的每个域的注释放在此域的右方。

说明：注释语言不统一，影响程 序易读性和外观排版，出于对维护人员的考虑，建议使用中文。