2.2.1 注释风格

注释可以让别人一看你的代码就明白其中的含义和用法， 但是不要过度注释，不要在注释里解释代码是如何运行的，一般你的注释应该告诉别人代码做了什么，而不是怎么做的，即结果，而非过程！

注释要放到函数的头部，尽量不要在函数体里面放置注释，注释的风格应该选择：

/* ……… */

而非：

//…………

对于多行注释，应该选择如下风格：

/*
* This is the preferred style for multi-line
* comments in the Linux kernel source code.
* Please use it consistently.
*
* Description: A column of asterisks on the left side,
* with beginning and ending almost-blank lines.
*/

每一行的开始处都应该放置符号“*”， 并且所有的行的“*”要对齐在一列上。

2.2.2 文件信息注释

在文件开始的地方应该对本文件做一个总体的、概括性的注释，比如：版权声明、版本号、作者、文件简介、修改日志等，如下所示的注释：

/*************************************************
Copyright © zuozhongkai Co., Ltd. 1998-2018. All rights reserved.
File name: // 文件名
Author： //作者
Version: //版本号
Description: // 用于详细说明此程序文件完成的主要功能，与其他模块
// 或函数的接口，输出值、取值范围、含义及参数间的控
// 制、顺序、独立或依赖等关系
Others: // 其它内容的说明
Log: // 修改日志，包括修改内容，日期，修改人等
*************************************************/

2.2.3 函数的注释

函数需要注释其作用，参数的含义以及返回值的含义，注释可以放在函数
声明的地方，也可以放在函数头，如下：

/*
*@ Description: 函数描述，描述本函数的基本功能
* @param 1 – 参数 1.
* @param 2 – 参数 2
* @return – 返回值
*/