資源描述：
《c語言編程規(guī)范》由會員上傳分享，免費在線閱讀，更多相關內容在教育資源-天天文庫。
1、C語言編程規(guī)范2008-9（一）編碼格式I注釋注釋是源碼程序中非常重要的一部分，一般情況下，源程序有效注釋量必須在15％以上。注釋的原則是有助于對程序的閱讀理解，所以注釋語言必須準確、易懂、簡潔。注釋不宜太多也不能太少，注釋的內容要清楚、明了，含義準確，防止注釋二義性，該加的地方一定要加，但不必要的地方一定不要加。（1）模塊（C文件）描述模塊描述中應該包括。版本號、生成日期、作者、內容、功能、與其它文件的關系、修改日志等。例如：/*************************************
2、**********************ModuleName://模塊的名字ModuleDate://生成日期ModuleAuth://作者名字Description://用于詳細說明此程序文件完成的主要功能，與其他模塊//或函數(shù)的接口，輸出值、取值范圍、含義及參數(shù)間的控//制、順序、獨立或依賴等關系Others://其它內容的說明RevisionHistory:DateRelVer.Notes月/日/年x.x//所進行的修改*************************************
3、**********************//*----------------Includes---------------*///包含的頭文件/*------------LocalVariables-----------*///定義一些本地變量/*------LocalStructuresandTypedefs---*///要使用的一些數(shù)據結構/*-----------ExternVariables-----------*///使用到的一些外部變量/*-------------Definition
4、s---------------*///一些#defines及具體的函數(shù)實現(xiàn)（2）頭文件描述頭文件一般包括了數(shù)據結構的定義，函數(shù)原形的說明，宏定義等，不許包含函數(shù)體和變量實體，文件名使用缺省的后綴.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）函數(shù)描述函數(shù)頭部應進行注釋，列出：函數(shù)的目的/功能、輸入參數(shù)、輸出參數(shù)、返回值、調用關（函數(shù)、表）等。例如：/***********************************************************FunctionName://函數(shù)名FunctionDescription://函數(shù)功能、性能等的描述Inputs://
