C语言注释规范_第1页
C语言注释规范_第2页
全文预览已结束

下载本文档

版权说明：本文档由用户提供并上传，收益归属内容提供方，若内容存在侵权，请进行举报或认领

文档简介

.C语言注释规范1. 注释原则l 同一软件项目开发中，尽量保持代码注释规范和统一。l 注释方便了代码的阅读和维护。l 边写代码边注释，修改代码时要相应修改注释，保证注释和代码的一致性。l 注释 要 简洁明确，不要出现形容词。l 对于写的好的注释，我们将是第一个受益者。l 大型软件开发中，通过别人的注释可以快速知道他人所写函数的功能，返回值，参数的使用。2. 文件头部的注释示例：/* Program Assignment :该文件的作用* Author: 作者* Date: 2013/8/6 14:34* Description: 该文件的描述*/* Source code in : 源代码的路径* Function List:*initLinear初始化线性表*destoryLinear释放线性表申请的空间*isLinearEmpty判断线性表是否为空*isLinearFull判断线性表是否为满*getLinearElementValue取得下标为index的元素的值*/注意：这个函数列表可以快速查询到我们想要了解的函数。3. 结构体，全局变量等的注释示例：typedef POLYNOMIAL USER_TYPE; /* 新的数据类型的描述 */int a; /* 全局变量的作用 */* 说明结构体的功能 */typedef struct LINEARUSER_TYPE *data; /* 每个成员的意义(作用) */int maxRoom; /* 每个成员的意义(作用) */int elementCount; /* 每个成员的意义(作用) */LINEAR;4. 函数的注释在逻辑性较强的的地方加入注释，以便其他人的理解，在一定的程度上排除bug。示例：/* Function Name: getLinearElementIndex* Purpose: 取得元素的index值* Params : *LINEARlinear线性表实例*USER_TYPE var类型为USER_TYPE的实例*int (*)() cmp提供接口，让用户定义具体比较函数* Return: int 返回元素的index值* Limitation: 如果返回-1，则代表不存在var的元素*/int getLinearElementIndex(LINEAR linear, USER_TYPE var, int (*cmp)()/* 如果逻辑太过复杂，这里写明 该算法的过程和思路。 */boolean found = FALSE;int i;for
人人文库> 全部分类> 教育资料 > 作文作品

温馨提示

  • 1. 本站所有资源如无特殊说明，都需要本地电脑安装OFFICE2007和PDF阅读器。图纸软件为CAD,CAXA,PROE,UG,SolidWorks等.压缩文件请下载最新的WinRAR软件解压。
  • 2. 本站的文档不包含任何第三方提供的附件图纸等，如果需要附件，请联系上传者。文件的所有权益归上传用户所有。
  • 3. 本站RAR压缩包中若带图纸，网页内容里面会有图纸预览，若没有图纸预览就没有图纸。
  • 4. 未经权益所有人同意不得将文件中的内容挪作商业或盈利用途。
  • 5. 人人文库网仅提供信息存储空间，仅对用户上传内容的表现方式做保护处理，对用户上传分享的文档内容本身不做任何修改或编辑，并不能对任何下载内容负责。
  • 6. 下载文件中如有侵权或不适当内容，请与我们联系，我们立即纠正。
  • 7. 本站不保证下载资源的准确性、安全性和完整性, 同时也不承担用户因使用这些下载资源对自己和他人造成任何形式的伤害或损失。

最新文档

评论

0/150

提交评论