C语言注释规范.doc

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

1、C语言注释规范1.注释原则l同一软件项目开发中，尽量保持代码注释规范和统一。l注释方便了代码的阅读和维护。l边写代码边注释，修改代码时要相应修改注释，保证注释和代码的一致性。l注释要简洁明确，不要出现形容词。l对于写的好的注释，我们将是第一个受益者。l大型软件开发中，通过别人的注释可以快速知道他人所写函数的功能，返回值，参数的使用。2.文件头部的注释示例：/*******************************************************ProgramAssignment:该文件的作用*Author:作者*Date:2

2、013/8/614:34*Description:该文件的描述*****************************************************//********************************************************Sourcecodein:源代码的路径*FunctionList:*initLinear初始化线性表*destoryLinear释放线性表申请的空间*isLinearEmpty判断线性表是否为空*isLinearFull判断线性表是否为满*getLinearEleme

3、ntValue取得下标为index的元素的值*******************************************************/注意：这个函数列表可以快速查询到我们想要了解的函数。3.结构体，全局变量等的注释示例：typedefPOLYNOMIALUSER_TYPE;/*新的数据类型的描述*/inta;/*全局变量的作用*//*说明结构体的功能*/typedefstructLINEAR{USER_TYPE*data;/*每个成员的意义(作用)*/intmaxRoom;/*每个成员的意义(作用)*/intelementC

4、ount;/*每个成员的意义(作用)*/}LINEAR;1.函数的注释在逻辑性较强的的地方加入注释，以便其他人的理解，在一定的程度上排除bug。示例：/********************************************************FunctionName:getLinearElementIndex*Purpose:取得元素的index值*Params:*@LINEARlinear线性表实例*@USER_TYPEvar类型为USER_TYPE的实例*@int(*)()cmp提供接口，让用户定义具体比较函数*Retu

5、rn:int返回元素的index值*Limitation:如果返回-1，则代表不存在var的元素*******************************************************/intgetLinearElementIndex(LINEARlinear,USER_TYPEvar,int(*cmp)()){/**如果逻辑太过复杂，这里写明该算法的过程和思路。*/booleanfound=FALSE;inti;for(i=0;i

6、data[i],var)==0)found=TRUE;if(i>=linear.elementCount)i=NOT_FOUND;returni;}