源代码书写规范.docVIP

  1. 1、本文档共5页,可阅读全部内容。
  2. 2、原创力文档(book118)网站文档一经付费(服务费),不意味着购买了该文档的版权,仅供个人/单位学习、研究之用,不得用于商业用途,未经授权,严禁复制、发行、汇编、翻译或者网络传播等,侵权必究。
  3. 3、本站所有内容均由合作方或网友上传,本站不对文档的完整性、权威性及其观点立场正确性做任何保证或承诺!文档内容仅供研究参考,付费前请自行鉴别。如您付费,意味着您自己接受本站规则且自行承担风险,本站不退款、不进行额外附加服务;查看《如何避免下载的几个坑》。如果您已付费下载过本站文档,您可以点击 这里二次下载
  4. 4、如文档侵犯商业秘密、侵犯著作权、侵犯人身权等,请点击“版权申诉”(推荐),也可以打举报电话:400-050-0827(电话支持时间:9:00-18:30)。
  5. 5、该文档为VIP文档,如果想要下载,成为VIP会员后,下载免费。
  6. 6、成为VIP后,下载本文档将扣除1次下载权益。下载后,不支持退款、换文档。如有疑问请联系我们
  7. 7、成为VIP后,您将拥有八大权益,权益包括:VIP文档下载权益、阅读免打扰、文档格式转换、高级专利检索、专属身份标志、高级客服、多端互通、版权登记。
  8. 8、VIP文档为合作方或网友上传,每下载1次, 网站将根据用户上传文档的质量评分、类型等,对文档贡献者给予高额补贴、流量扶持。如果你也想贡献VIP文档。上传文档
查看更多
源代码书写规范

源代码书写规范 1) 目的 有一个好的代码可读性;使得你读别人的代码和别人读你的代码一样容易; 避免坏的代码习惯,规范的代码不容易引进bug,而且易于维护; 有一致的代码风格,看上去所有的代码就象一个人写的; 声明 所有这些条款是强制性的,不许做任何更改,除非有明确的建议性的词语,象“推荐”、“建议”、“试着”等; 本代码规范以c,C++为示例,其他语言,以该语言为基础,以本规范为框架; 宗旨 代码规范的宗旨是:程序结构和可读性第一,优化第二; 文件协定 文件的扩展名符合扩展名约定,如C语言文件扩展名用.c,C++扩展名用.cpp,头文件的扩展名用.h。 所有的文件必须有一个“头部分”,描述文件功能,象接下来的样子: /* *************************************************************** * * 装载共享工具 * * 文件名 * * 描述本文件包括什么功能 * * (输出函数): * * (输出函数和它们的描述) * * (输出变量): * * (输出变量和它们的描述) * ************************************************************** */ 函数与过程 每一个函数必须有一个头部,用来描述函数功能,其格式象下面: ----5 /* *----------------------------------------------------------------------- * * (函数名) -- * * 参数: * * (输入输出参数和它们的描述) * * 前提条件: * * (调本函数的前提条件) * * 描述: * * (函数是做什么的和函数的算法) * * 副作用: * * (任何副作用,象改变全局变量) * * 返回值: * * (返回值和它们的描述) * * 编写人和编写时间 * * 修改记录 * (每一次修改人和修改时间) *--------------------------------------------------------------- 注意:函数头描述以------------------------开始,而代替文件头描述以**********************开始。 代码排版 所有的全局变量,外部变量,包含头文件,都将被列出在第一个函数前; 每一个处理部分用一个该部分的注释,在每两个部分之间空一行 缩进字符数。一个indent=4 spaces,一个 tab=8 spaces,建议用空格代替tab; if-else ,for , while, switch等的排版布局; 在关键字和()之间建议有一个空格 只有接下来的风格被用,除非你有一个特别原因 if (replyCode == REQ_ACCEPTED) { for (ii = 0; ii resrcNum; ii++) { resrcAry[ii] += 1; } } else if (replyCode == REQ_INITIALIZE) { ii = 0; while (ii resrcNum) { resrcAry[ii++] = 0; } } else { switch (errCode) { case PERMISION_DENY: printf(Permision denied); break; case RESOURCE_LIMITED: printf(Resource limit is reached); break; default: printf(Unknown error code %d, errCode); } } 假设一行80个字符,长于80个字符,可以象

文档评论(0)

zw4044 + 关注
实名认证
文档贡献者

该用户很懒,什么也没介绍

1亿VIP精品文档

相关文档