c语言编程规范

《c语言编程规范》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、C语言编程规范2008-9（一）编码格式I注释注释是源码程序中非常重要的一部分，一般情况下，源程序有效注释量必须在15％以上。注释的原则是有助于对程序的阅读理解，所以注释语言必须准确、易懂、简洁。注释不宜太多也不能太少，注释的内容要清楚、明了，含义准确，防止注释二义性，该加的地方一定要加，但不必要的地方一定不要加。（1）模块（C文件）描述模块描述中应该包括。版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等。例如：/*************************************

2、**********************ModuleName://模块的名字ModuleDate://生成日期ModuleAuth://作者名字Description://用于详细说明此程序文件完成的主要功能，与其他模块//或函数的接口，输出值、取值范围、含义及参数间的控//制、顺序、独立或依赖等关系Others://其它内容的说明RevisionHistory:DateRelVer.Notes月/日/年x.x//所进行的修改*************************************

3、**********************//*----------------Includes---------------*///包含的头文件/*------------LocalVariables-----------*///定义一些本地变量/*------LocalStructuresandTypedefs---*///要使用的一些数据结构/*-----------ExternVariables-----------*///使用到的一些外部变量/*-------------Definition

4、s---------------*///一些#defines及具体的函数实现（2）头文件描述头文件一般包括了数据结构的定义，函数原形的说明，宏定义等，不许包含函数体和变量实体，文件名使用缺省的后缀.h，头文件的注释可如下：#ifndefMODEL_H#defineMODEL_H/***********************************************************ModuleName:model.hModuleDate:month/day/yearModuleAuth:y

5、ournameDescription:ashortintroductionofthismodule.RevisionHistory:DateRelVer.Notesmonth/day/yearx.x[e.g.]Modulecreated***********************************************************//*----------------Includes---------------*///theheadfilesthatwereincluded//[

6、e.g.]#include"head.h"/*---------StructuresandTypedefs-------*//*[e.g.]structmodel{charMemberOne;intMemberTwo;charMemberThree[3];structmodule*MemberFour;}enumBOOL{TRUE,FALSE};typedefstructmoduleMODULE;*//*---------------Defines-----------------*///[e.g.]#

7、defineMODLE2/*----------externvariables-------------*///thevariablesthatweredefinedinothermodules//[e.g.]esterncharExternVariable;/*-----ExternalFunctionPrototypes------*//*ExternalFunctionPrototypes*///thefunctionsthatwereimplementedinothermodules//[e.g

8、.]externunsignedcharmodel(intInput[2]);#endif（3）函数描述函数头部应进行注释，列出：函数的目的/功能、输入参数、输出参数、返回值、调用关（函数、表）等。例如：/***********************************************************FunctionName://函数名FunctionDescription://函数功能、性能等的描述Inputs://