代码编写与文档注释规范.docVIP

下载本文档

2
0
约小于1千字
约 3页
2017-09-05 发布于浙江
举报
版权申诉

代码编写与文档注释规范.doc

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

代码编写与文档注释规范

文档注释与代码编写规范源代码内部注释规则 1.1.规则1：文件包含文件头，需要说明文件名、作者、创建时间、变更记录等。 1.2.类及成员注释 1.2.1.规则1：对方法和类的注释要使用三斜线(///)。 1.2.2.成员属性注释 1.2.3.成员函数注释 1.2.4.函数内部注释代码命名规范和行为规范 2.1 命名规范目前主要存在3种命名规则：骆驼命名法(Camel): 首单词小写，随后单词首字母大写。如：void printEmployeePay(); 帕斯卡命名法(Pascal): 所有单词首字母大写。匈牙利命名法(Hungarian) 变量名=类型+对象描述，类型以小写字母开头，对象描述以一个或多个单词组合，首字母大写。如表单名称为form，简称frm，当表单变量名称为student时，命名为frmStudent。一般来说C#提倡使用骆驼命名法和帕斯卡命名法。 2.2 命名规范事例 2.2.1 类的命名规范 Pascal命名法。如class Person class BmpFileStream 2.2.2 类字段命名规范使用Camel命名规则为类成员变量命名，首单词小写。 2.2.3 方法命名规范 Pascal命名法。 2.2.4 属性命名规范 Pascal命名法。 2.2.5 参数命名规范使用Camel命名规则为类成员变量命名，首单词小写。 2.2.6 常量命名规范 Pascal命名法。 2.2.7 接口命名规范 Pascal命名法,必须以大写I开头。 2.2.8 事件命名规范 Pascal命名法。 2.2.9 命名空间命名规范 Pascal命名法。代码命名规范和行为规范 3.1缩写规范 3.2排版规范 3.3语句结构规范 3.4代码缩进规范 3.5大小写规范 3.6重名规范 3.7系统命名规范