代码及函数注释头整理

源程序文件头及函数头注释整理

由于产品开发进度紧张，软件开发人员往往忽视代码注释的重要性，导致代码维护困难，可读性较差，为软件质量问题埋下隐患。其实，磨刀不误砍柴工，良好的代码注释习惯不仅为了体现个人软件编程的专业素质，随着代码量的剧增，自己维护起来也会逻辑清晰。下面将源程序文件头及函数头注释整理如下，便于以后参考查看。

源程序文件头注释

/**************************************************************************** 
-	Copyright (c) 2021, Wu-zhirui
- File name : main.c
- Author : Wu-zhirui				Version:3.0				Data:2021.03.35
- Description:   eg.4G module AT code send and receive by ttyUSB0
                 //用于详细说明此程序文件完成的主要功能，
                 //与其他模块或函数的接口，输出值，取值范围，含义
                 //及参数间的控制、顺序、独立或依赖等关系
- Others :       //其他内容说明
- Function List: //主要函数列表，每条记录应包括函数名及功能简要说明
  1、......
  2、......
- History :      //修改历史记录列表，每条修改记录修改日期、修改者
								 //以及修改内容
  1、Data:...
     Author:...
     Modification:...
  2、
******************************************************************************/ 

函数头注释

/**************************************************************************** 
-	Function :        //函数名称
- Description :     //函数功能，性能等描述
- Calls :           //本函数被调用的函数清单
- Callded By:       //调用本函数的清单
- Input:            //输入参数说明，包括每个参数的作用，取值说明及参数间关系
- Output:           //对输出参数的说明
- Return:           //对输出参数的说明
- Others :          //其他内容说明
******************************************************************************/