注释对于我们写代码的一些重要性

注释的作用：

1.说明函数的功能

2.说明函数参数的意思

3.说明函数这样设计的原理（计算公式）

4.说明函数的使用场景

5.作者和日期

6.说明变量的作用

7.函数调用方法与注意事项

要注释是多么重要的一件事情啊。

所以写代码需其实注释没有特别严格的注释格式，但是为了使得注释整齐简洁。还是会有一些格式的要求的。针对不同开发平台，不同编程语言，都有各自不同的注释推荐格式。

命名基本原则

(1)命名清晰明了，有明确含义，使用完整单词或约定俗成的缩写。通常，较短的单词可通过去掉元音字母形成缩写；较长的单词可取单词的头几个字母形成缩写。即"见名知意"。

(2)命名风格要自始至终保持一致。

(3)命名中若使用特殊约定或缩写，要有注释说明。

(4)同一软件产品内模块之间接口部分的标识符名称之前加上模块标识。

宏和常量用全部大写字母来命名，词与词之间用下划线分隔。对程序中用到的数字均应用有意义的枚举或宏来代替。

变量名用小写字母命名，每个词的第一个字母大写。类型前缀(u8s8 etc.)全局变量另加前缀g_。

局部变量应简明扼要。局部循环体控制变量优先使用i、j、k等；局部长度变量优先使用len、num等；临时中间变量优先使用temp、tmp等。

函数名用小写字母命名，每个词的第一个字母大写，并将模块标识加在最前面。

一个文件包含一类功能或一个模块的所有函数，文件名称应清楚表明其功能或性质。每个.c文件应该有一个同名的.h文件作为头文件。

文件注释必须说明文件名、函数功能、创建人、创建日期、版本信息等相关信息。修改文件代码时，应在文件注释中记录修改日期、修改人员，并简要说明此次修改的目的。所有修改记录必须保持完整。文件注释放在文件顶端，用"/*……*/"格式包含。注释文本每行缩进4个空格；每个注释文本分项名称应对齐。

/***********************************************************

文件名称：

作者：

版本：

说明：

修改记录：

***********************************************************/

函数头部注释应包括函数名称、函数功能、入口参数、出口参数等内容。如有必要还可增加作者、创建日期、修改记录(备注)等相关项目。函数头部注释放在每个函数的顶端，用"/*……*/"的格式包含。其中函数名称应简写为Name()，不加入、出口参数等信息。

/***********************************************************

函数名称：

函数功能：

入口参数：

出口参数：

备注：

***********************************************************/

注释加深对程序的理解。如果能够对程序中每句话加上正确合理的注释，那么说明对程序的掌握是很到位的。尤其是在自己编写程序时、或者抄别人程序时，难免会出现语法错误和现象不符，这时如果能够对每句话加以注释，就能大大加深对程序的理解，也能更快的找到问题所在。试想，对程序中的每句话都加上了清晰明了的注释，还会看不懂程序吗。在注释过程中，在哪里卡住了，或者无法做出合理的解释，那么很有可能这就是问题所在。

便于以后回看。人的记忆是有限的，一段没有注释的程序在闲置一段时间后，再次看时，可能会看不懂程序写的说什么意思。这时详细的注释就像是产品说明书，配合着注释，能够在短时间内明白程序所写的含义。