前言
制定C语言的编程规范,对代码的清晰、简洁、可测试、安全、程序效率、可移植各个方面有巨大的作用。
良好的注释能让整个代码读起来更加流畅,此乃程序猿出差旅行,通宵熬夜必备良药……
注释的原则
注释的目的是解释代码的目的、功能和采用的方法,提供代码以外的信息,帮助读者理解代码,防止没必要的重复注释信息。 示例:如下注释意义不大。
/* if receive_flag is TRUE */
if (receive_flag)
而如下的注释则给出了额外有用的信息。
/* if mtp receive a message from links */
if (receive_flag)
说明性文件头部应进行注释
说明性文件(如头文件.h 文件、.inc 文件、.def 文件、编译说明文件.cfg 等)头部应进行注释,注释必须列出:版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等,头文件的注释中还应有函数功能简要说明。
示例:下面这段头文件的头注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内。
/**
* Copyright (C), 1988-1999, Huawei Tech. Co., Ltd.
* File name: // 文件名
* Author: Version: Date: // 作者、版本及完成日期
* Description: // 用于详细说明此程序文件完成的主要功能,与其他模块
// 或函数的接口,输出值、取值范围、含义及参数间的控
// 制、顺序、独立或依赖等关系
* Others: // 其它内容的说明
* Function List: // 主要函数列表,每条记录应包括函数名及功能简要说明
1. ….
* History: // 修改历史记录列表,每条修改记录应包括修改日期、修改
// 者及修改内容简述
1. Date:
Author:
Modification:
2. …
*/
源文件头部应进行注释
源文件头部应进行注释,列出:版权说明、版本号、生成日期、作者、模块目的/功能、主要函数及其功能、修改日志等。
示例:下面这段源文件的头注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内。
/**
* Copyrig