服务端相关 / 05 C 语言中的注释

C 语言中的注释

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

在自由软件出现后,注释的更为重要的功能就是声明软件的授权使用协议。这在除我国在外的,其他很多国家具有法律效力。

1. C 语言的注释标准

C 语言的注释目前有两种:

  • 多行注释(经典式注释)
  • 单行注释(C++ 式注释)

1.1 多行注释

/* 注释内容 */ 形式出现的注释。注释可以写在一行,也可以跨越多行。只要在注释的开始使用 /* 标明,在注释全部写完后用 */ 结束就可以了。被这两组符号包围的部分就是注释主体。

/* 注释的示范程序
可以跨越多行进行注释
*/
/**************************************
为了强调可以这样标注,可以写很长的注释体。
一般自由软件会有很长的授权协议写在开头,
大家使用别人软件的时候请仔细阅读。
***************************************/

# include <stdio.h>

int main()
{
    /* 声明变量 */
    int x,y,z;
    return 0;  /* 返回值 */
}

1.2 单行注释

但是如果不使用 IDE ,而使用键盘敲击注释内容,每次都要敲击 4 次键盘才能完成一次注释,对于一些简短的注释来说是比较麻烦的。

因此在 C++ 语言设计的时候,就出现了使用 // 来进行单行注释的方法。请注意,这里编译器只会忽略 // 后面到本行行末的部分。也就是只能注释一行。这与使用 /* */ 方式注释可以同时注释多行的方式有所不同。这种注释的方法优缺点显而易见。与上面的传统方式优势互补。

Tips:需要特别注意的是,对于几十年前的老旧的编译器,这种注释方式会引起错误。当然,最近十年的编译器已经可以支持这种新的注释标准了。

# include <stdio.h>

int main()
{
    // 声明变量
    int x,y,z;
    return 0;  // 返回值
}

将两种注释方式混合使用的例子。

/*
使用第一种方式注释
*/


# include <stdio.h>

int main()
{
    // 使用第二种方式注释
    int x,y,z;
    return 0;
}

2. 小结

对于 C 语言的注释,这里有两种方式:

  • 多行注释(经典式注释)
  • 单行注释(C++ 式注释)

经典式可以注释多行,使用 /* */ 来进行注释,而 C++ 式的注释提供了更为便捷的注释方式,只能注释单行,使用 // 进行注释。大家可以根据实际需要选择。但是要切记,作为一个程序员良好的素养就是做好注释。没有注释的程序是不完整的程序,因为程序阅读的对象是人。