如何让自己的代码看着更高级---探索版（一）

如何让自己的代码看着更高级些（一）

一、注释种类

C语言注释主要有两种：

1、形式为/* 注释内容 */

/* 注释内容 */，是C89标准引入的。

这种注释可以单行，也可以多行。

2、形式为//注释内容

//注释内容，这是单行注释，是C99标准引入的。

大部分编译器兼容这两种注释。

二、巧用注释

错误示例

#include <stdio.h>
​
//int i;
int main ()
{
//i++;
//if(i>100) i=0;
printf("hello world");
}

以上代码看着并不高级，注释内容说明没有，不好一眼读懂代码。。。

修改如下

/***
*******************************************************
**author:小邱
**function:main.c
**date:2023.8.8
*******************************************************
***/
​
​
#include <stdio.h>
​
int main ()
{
    printf("hello world"); /*打印hello world输出测试*/
}

​
删除代码中非必要注释，只保留必要代码，在重要性代码后写明功能内容，如上。这样一看是不是比上面高级一点呢。

三、注释的小技巧

1、在各个头文件（各种c和h文件）注释本文件功能、作者和日期，注释内容可参考以下：

/***
*******************************************************
**author:小邱
**function:main.c
**date:2023.8.8
*******************************************************
***/
​

2、在代码中的注释

2、1 对代码进行注释

如果是对代码注释，单行代码使用//，单行代码使用/* */。

2、2 对代码解释说明

有时我们需要解释下代码内容，这个时候注释最好不用“//注释内容”，这种注释比较不整齐，尽量使用 ”/* /“。个人认为”/ */ “比较适合解释说明。

如果代码内容多，建议集中解释，不在单独去解释。