C语言注释
规范
编程规范下载gsp规范下载钢格栅规范下载警徽规范下载建设厅规范下载
C语言注释规范PAGEC语言注释规范C语言注释规范注释原则同一软件项目开发中，尽量保持代码注释规范和统一。注释方便了代码的阅读和维护。边写代码边注释，修改代码时要相应修改注释，保证注释和代码的一致性。注释要简洁明确，不要出现形容词。对于写的好的注释，我们将是第一个受益者。大型软件开发中，通过别人的注释可以快速知道他人所写函数的功能，返回值，参数的使用。文件头部的注释示例：/*******************************************************ProgramAssignment:该文件的作用*Author:作者*Date:2013/8/614:34*Description:该文件的描述*****************************************************//********************************************************Sourcecodein:源代码的路径*FunctionList:*initLinear初始化线性
表
关于同志近三年现实表现材料材料类招标技术评分表图表与交易pdf视力表打印pdf用图表说话 pdf
*destoryLinear释放线性表申请的空间*isLinearEmpty判断线性表是否为空*isLinearFull判断线性表是否为满*getLinearElementValue取得下标为index的元素的值*******************************************************/注意：这个函数列表可以快速查询到我们想要了解的函数。结构体，全局变量等的注释示例：typedefPOLYNOMIALUSER_TYPE;/*新的数据类型的描述*/inta;/*全局变量的作用*//*说明结构体的功能*/typedefstructLINEAR{USER_TYPE*data;/*每个成员的意义(作用)*/intmaxRoom;/*每个成员的意义(作用)*/intelementCount;/*每个成员的意义(作用)*/}LINEAR;函数的注释在逻辑性较强的的地方加入注释，以便其他人的理解，在一定的程度上排除bug。示例：/********************************************************FunctionName:getLinearElementIndex*Purpose:取得元素的index值*Params:*@LINEARlinear线性表实例*@USER_TYPEvar类型为USER_TYPE的实例*@int(*)()cmp提供接口，让用户定义具体比较函数*Return:int返回元素的index值*Limitation:如果返回-1，则代表不存在var的元素*******************************************************/intgetLinearElementIndex(LINEARlinear,USER_TYPEvar,int(*cmp)()){/**如果逻辑太过复杂，这里写明该算法的过程和思路。*/booleanfound=FALSE;inti;for(i=0;i<&&!found;i++)if(cmp[i],var)==0)found=TRUE;if(i>=i=NOT_FOUND;returni;}
浙公网安备 33021202002483