C语言注释规范1.注释原则同一软件项目开发中，尽量保持代码注释规范和统一。注释方便了代码的阅读和维护。边写代码边注释，修改代码时要相应修改注释，保证注释和代码的一致性。注释要简洁明确，不要出现形容词。对于写的好的注释，我们将是第一个受益者。大型软件开发中，通过别人的注释可以快速知道他人所写函数的功能，返2我件头部的注释示例：该文件的作用作者20138/614:34该文件的描述/ProgramAssignment:Author:Date:Description:*****//*Sourcecodein:源代码的路径*FunctionList:*initLinear初始化线性表*destoryLinear释放线性表申请的空间*isLinearEmpty判断线性表是否为空*isLinearFull判断线性表是否为满*getLinearElementValue取得下标为index的兀素的值*/3结意构这个函数全局以快速量等等我们注释的函数°示例：typedefPOLYNOMIALUSER_TYPE;/*新的数据类型的描述*/inta;/*全局变量的作用*//*说明结构体的功能*/typedefstructLINEAR{USER_TYPE*data;/*每个成员的意义（作用）*/intmaxRoom;/*每个成员的意义（作用）*/intelementCount;/*每个成员的意义（作用）*/}LINEAR;4.函数的注释在逻辑性较强的的地方加入注释，以便其他人的理解，在一定的程度上排除bug。示例/*getLinearElementIndex取得元素的index值*FunctionName:*Purpose:*Params:*@LINEARlinear线性表实例*@USER_TYPEvar*@int(*)()cmp*Return:int类型为USER_TYPE的实例提供接口，让用户定义具体比较函数返回元素的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;
本文档为【C语言注释规范】，请使用软件OFFICE或WPS软件打开。作品中的文字与图均可以修改和编辑，
图片更改请在作品中右键图片并更换，文字修改请直接点击文字进行修改，也可以新增和删除文档中的内容。
该文档来自用户分享，如有侵权行为请发邮件ishare@vip.sina.com联系网站客服，我们会及时删除。
[版权声明] 本站所有资料为用户分享产生，若发现您的权利被侵害，请联系客服邮件isharekefu@iask.cn，我们尽快处理。
本作品所展示的图片、画像、字体、音乐的版权可能需版权方额外授权，请谨慎使用。
网站提供的党政主题相关内容(国旗、国徽、党徽..)目的在于配合国家政策宣传，仅限个人学习分享使用，禁止用于任何广告和商用目的。
浙公网安备 33021202002483