Linux C程序设计之注释篇(linuxc注释)
注释是指程序中的文档,也称为注解、文档或解释语句。按照规范编写C语言代码,往往需要在代码中加入提示性说明。可以将注释看作是对C语言代码的解释说明,它可以提供关于被注释语句代码实现功能的一些描述和说明,有利于开发者理解代码。
C语言 的注释格式有单行注释和多行注释两种,而且两种形式的注释也有不同的表示格式。具体而言,单行注释的表示形式是以双斜线(//)符号开头:
/* 这是多行注释 */
// 这是单行注释
在Linux C程序中,需要使用单行圆括号(/*)作为注释开头,然后圆括号(*/)作为结尾,中间是文档注释。一般使用多行注释做函数/程序的文档性描述,单行注释则可以在程序的运行的相关的代码中,给出一些相关的提示性的文字说明。比如,以下是一段用来示范如何使用多行注释的C语句:
/*
* 该函数用于实现分配一段连续的内存空间
* @param size 要分配的字节数
* @return 指向分配的内存空间首地址的指针
*/
void* malloc(size_t size)
{
//申请内存空间及检查
//…
//返回分配的内存空间地址
//…
return NULL;
}
总之,当使用C语言编程时,适量的注释可以极大地提高其代码的可读性,也是有语义且规范编码的基础。