C命名标准规范专业资料.doc
《C命名标准规范专业资料.doc》由会员分享,可在线阅读,更多相关《C命名标准规范专业资料.doc(45页珍藏版)》请在咨信网上搜索。
1、C#编程规范 Version 2.0目录第一章概述4规范制定原则4术语定义4Pascal 大小写4Camel 大小写4文献命名组织41.3.1文献命名41.3.2文献注释4第二章 代码外观62.1列宽62.2换行62.3缩进62.4空行62.5空格62.6括号 - ()72.7花括号 - 7第三章 程序注释93.4注释概述93.2文档型注释93.3类c注释103.4单行注释103.5注释标签10第四章声明144.1每行声明数144.2初始化144.3位置144.4类和接口声明154.5字段声明15第五章命名规范165.1命名概述165.2大小写规则165.3缩写175.4命名空间175.5类1
2、85.6接口185.7属性 (Attribute)195.8枚举 (Enum)195.9参数195.10办法205.11属性 (property)205.12事件215.13常量 (const)225.14字段235.15静态字段235.16集合245.17措词24第六章语句266.1每行一种语句266.2复合语句266.3return 语句266.4if、if-else、if else-if 语句266.4 for、foreach 语句276.5while 语句276.7.do - while 语句286.8.switch - case 语句286.9.try - catch 语句286.1
3、0.using 块语句296.11.goto 语句29第七章控件命名规则307.1命名办法307.2重要控件名简写对照表30第八章其她308.1表达式308.2类型转换30附录一:匈牙利命名法31第一章概述规范制定原则 1 以便代码交流和维护。 2 不影响编码效率,不与大众习惯冲突。 3 使代码更美观、阅读更以便。 4 使代码逻辑更清晰、更易于理解。术语定义Pascal 大小写 将标记符首字母和背面连接每个单词首字母都大写。可以对三字符或更多字符标记符使用Pascal 大小写。例如: BackColorCamel 大小写标记符首字母小写,而每个背面连接单词首字母都大写。例如: backColo
4、r文献命名组织1.3.1文献命名1 文献名遵从Pascal命名法,无特殊状况,扩展名小写。2 使用统一而又通用文献扩展名: C# 类 .cs1.3.2文献注释 1 在每个文献头必要包括如下注释阐明 /*- / Copyright (C) 北京大陆康腾科技有限公司 / 版权所有。 / / 文献名: / 文献功能描述: / / / 创立标记: / / 修改标记: / 修改描述: / / 修改标记: / 修改描述:/-*/文献功能描述只需简述,详细详情在类注释中描述。创立标记和修改标记由创立或修改人员拼音或英文名加日期构成。如: 小新 -2-10一天内有各种修改只需做一种在注释阐明中做一种修改标记就
5、够了。在所有代码修改处加上修改标记注释。第二章 代码外观2.1列宽 代码列宽控制在110字符左右。2.2换行 当表达式超过或即将超过规定列宽,遵循如下规则进行换行 1、在逗号后换行。 2、在操作符前换行。 3、规则1优先于规则2。 当以上规则会导致代码混乱时候自己采用更灵活换行规则。 2.3缩进 Visual Studio.Net默认设立即可。需要统一设立某一文档格式时,点击编辑高档设立文档格式。或Ctrl + E,D组合键。2.4空行空行是为了将逻辑上有关联代码分块,以便提高代码可阅读性。 在如下状况下使用两个空行 1、接口和类定义之间。 2、枚举和类定义之间。 3、类与类定义之间。 在如下
6、状况下使用一种空行 1、办法与办法、属性与属性之间。 2、办法中变量声明与语句之间。 3、办法与办法之间。 4、办法中不同逻辑块之间。 5、办法中返回语句与其她语句之间。 6、属性与办法、属性与字段、办法与字段之间。 7、注释与它注释语句间不空行,但与其她语句间空一行。2.5空格在如下状况中要使用到空格 1、核心字和左括符 “(” 应当用空格隔开。如 while (true) 注旨在办法名和左括符 “(” 之间不要使用空格,这样有助于辨认代码中办法调用与核心字。 2、 各种参数用逗号隔开,每个逗号后都应加一种空格。3、 除了 . 之外,所有二元操作符都应用空格与它们操作数隔开。一元操作符、+及
7、-与操作 数间不需要空格。如 a += c + d; a = (a + b) / (c * d); while (d+ = s+) n+; PrintSize(“size is “ + size + “n”);4、语句中表达式之间用空格隔开。如 for (expr1; expr2; expr3)2.6括号 - () 1、左括号“(” 不要紧靠核心字,中间用一种空格隔开。 2、左括号“(” 与办法名之间不要添加任何空格。 3、没有必要话不要在返回语句中使用()。如 if (condition) Array.Remove(1) return 1 2.7花括号 - 1、左花括号 “” 放于核心字或办
8、法名下一行并与之对齐。如 if (condition) public int Add(int x,int y) 2、左花括号 “” 要与相应右花括号 “”对齐。 3、普通状况下左花括号 “”单独成行,不与任何语句并列一行。 4、if、while、do语句后一定要使用,虽然号中为空或只有一条语句。如 if (somevalue = 1) somevalue = 2; 5、右花括号 “” 后建议加一种注释以便于以便找到与之相应 。如 while (1) if (valid) / if valid else / not valid / end forever第三章 程序注释3.4注释概述1、修改代码
9、时,总是使代码周边注释保持最新。2、在每个例程开始,提供原则注释样本以批示例程用途、假设和限制很有协助。注释样本应当是解释它为什么存在和可以做什么简短简介.3、避免在代码行末尾添加注释;行尾注释使代码更难阅读。但是在批注变量声明时,行尾注释是适当;在这种状况下,将所有行尾注释在公共制表位处对齐。 4 、避免杂乱注释,如一整行星号。而是应当使用空白将注释同代码分开。 5 、避免在块注释周边加上印刷框。这样看起来也许很美丽,但是难于维护。6 、在布置发布之前,移除所有暂时或无关注释,以避免在日后维护工作中产生混乱。7 、如果需要用注释来解释复杂代码节,请检查此代码以拟定与否应当重写它。尽一切也许不
10、注释难以理解代码,而应当重写它。尽管普通不应当为了使代码更简朴以便于人们使用而牺牲性能,但必要保持性能和可维护性之间平衡。8 、在编写注释时使用完整句子。注释应当阐明代码,而不应当增长多义性。 9 、在编写代码时就注释,由于后来很也许没有时间这样做。此外,如果有机会复查已编写代码,在今天看来很明显东西六周后来或许就不明显了。10 、避免多余或不恰当注释,如幽默不重要备注。11、使用注释来解释代码意图。它们不应作为代码联机翻译。 12、注释代码中不十分明显任何内容。13 、为了防止问题重复浮现,对错误修复和解决办法代码总是使用注释,特别是在团队环境中。14 、对由循环和逻辑分支构成代码使用注释。
11、这些是协助源代码读者重要方面。 15 、在整个应用程序中,使用品有一致标点和构造统同样式来构造注释。 16 、用空白将注释同注释分隔符分开。在没有颜色提示状况下查看注释时,这样做会使注释很明显且容易被找到。17 、在所有代码修改处加上修改标记注释。18 、为了是层次清晰,在闭合右花括号后注释该闭合所相应起点。 namespace Cont.MIS / namespace Cont.MIS3.2文档型注释 该类注释采用.Net已定义好Xml标签来标记,在声明接口、类、办法、属性、字段都应当使用该类注释,以便代码完毕后直接生成代码文档,让别人更好理解代码实现和接口。如/MyMethod is a
12、method in the MyClass class./Heres how you could make a second paragraph in a description./ /for information about output statements./ / / public static void MyMethod(int Int1) 3.3类c注释 该类注释用于 1 不再使用代码。 2 暂时测试屏蔽某些代码。 用法 /*修改标记修改因素. . . (the source code )*/3.4单行注释 该类注释用于1 办法内代码注释。如变量声明、代码或代码段解释。注释示例:
13、/ 注释语句 private int number; 2 办法内变量声明或花括号后注释,注释示例: if ( 1 = 1) / always true statement; / always true3.5注释标签 标签用法作用c错误!超链接引用无效。 text 但愿将其批示为代码文本。为您提供了一种将阐明中文本标记为代码办法。使用 将多行批示为代码错误!超链接引用无效。content段落文本。用于诸如 或 等标记内,使您得以将构造添加到文本中。错误!超链接引用无效。name 为办法参数名。将此名称用单引号括起来 ( )。应当用于办法声明注释中,以描述办法一种参数。 name 要引用参数名。将
14、此名称用双引号括起来 ( )。 标记为您提供了一种批示词为参数办法。可以解决 XML 文献,从而用某种独特办法格式化该参数。cref = member 对可以通过当前编译环境进行调用成员或字段引用。编译器检查到给定代码元素存在后,将 member 传递给输出 XML 中元素名。必要将 member 括在双引号 ( ) 中。使您得以从文本内指定链接。使用 批示但愿在“请参阅”一节中浮现文本。cref = member 对可以通过当前编译环境进行调用成员或字段引用。编译器检查到给定代码元素存在后,将 member 传递给输出 XML 中元素名。必要将 member 括在双引号 ( ) 中使您得以指
15、定但愿在“请参阅”一节中浮现文本。使用 从文本错误!超链接引用无效。description 代码示例阐明。使用 标记可以指定用法或其她库成员示例。普通状况下,这将涉及到 标记使用。错误!超链接引用无效。content 为但愿将其标记为代码文本。 记为您提供了一种将多行批示为代码办法。使用 批示应将阐明中文本标记为代码错误!超链接引用无效。此处description 为对象摘要。应当用于描述类型成员。使用 以提供关于类型自身信息。错误!超链接引用无效。cref = member 对可从当前编译环境中获取异常引用。编译器检查到给定异常存在后,将 member 转换为输出 XML 中规范化元素名。必
16、要将 member 括在双引号 ( ) 中。description 阐明。 标记使您可以指定类可以引起异常。filename 包括文档文献名。该文献名可用途径加以限定。将 filename 括在单引号中 ( )。 Tagpath:filename 中指向标记名标记途径。将此途径括在单引号中 ( )。 name 注释前边标记中名称阐明符;名称具备一种 id。 id 位于注释之前标记 id。将此 id 括在双引号中 ( )。 标记使您得以引用描述源代码中类型和成员另一文献中注释。这是除了将文档注释直接置于源代码文献中之外另一种可选办法。 标记使用 XML XPath 语法。关于自定义 用法,请参阅
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 命名 标准规范 专业 资料
1、咨信平台为文档C2C交易模式,即用户上传的文档直接被用户下载,收益归上传人(含作者)所有;本站仅是提供信息存储空间和展示预览,仅对用户上传内容的表现方式做保护处理,对上载内容不做任何修改或编辑。所展示的作品文档包括内容和图片全部来源于网络用户和作者上传投稿,我们不确定上传用户享有完全著作权,根据《信息网络传播权保护条例》,如果侵犯了您的版权、权益或隐私,请联系我们,核实后会尽快下架及时删除,并可随时和客服了解处理情况,尊重保护知识产权我们共同努力。
2、文档的总页数、文档格式和文档大小以系统显示为准(内容中显示的页数不一定正确),网站客服只以系统显示的页数、文件格式、文档大小作为仲裁依据,平台无法对文档的真实性、完整性、权威性、准确性、专业性及其观点立场做任何保证或承诺,下载前须认真查看,确认无误后再购买,务必慎重购买;若有违法违纪将进行移交司法处理,若涉侵权平台将进行基本处罚并下架。
3、本站所有内容均由用户上传,付费前请自行鉴别,如您付费,意味着您已接受本站规则且自行承担风险,本站不进行额外附加服务,虚拟产品一经售出概不退款(未进行购买下载可退充值款),文档一经付费(服务费)、不意味着购买了该文档的版权,仅供个人/单位学习、研究之用,不得用于商业用途,未经授权,严禁复制、发行、汇编、翻译或者网络传播等,侵权必究。
4、如你看到网页展示的文档有www.zixin.com.cn水印,是因预览和防盗链等技术需要对页面进行转换压缩成图而已,我们并不对上传的文档进行任何编辑或修改,文档下载后都不会有水印标识(原文档上传前个别存留的除外),下载后原文更清晰;试题试卷类文档,如果标题没有明确说明有答案则都视为没有答案,请知晓;PPT和DOC文档可被视为“模板”,允许上传人保留章节、目录结构的情况下删减部份的内容;PDF文档不管是原文档转换或图片扫描而得,本站不作要求视为允许,下载前自行私信或留言给上传者【a199****6536】。
5、本文档所展示的图片、画像、字体、音乐的版权可能需版权方额外授权,请谨慎使用;网站提供的党政主题相关内容(国旗、国徽、党徽--等)目的在于配合国家政策宣传,仅限个人学习分享使用,禁止用于任何广告和商用目的。
6、文档遇到问题,请及时私信或留言给本站上传会员【a199****6536】,需本站解决可联系【 微信客服】、【 QQ客服】,若有其他问题请点击或扫码反馈【 服务填表】;文档侵犯商业秘密、侵犯著作权、侵犯人身权等,请点击“【 版权申诉】”(推荐),意见反馈和侵权处理邮箱:1219186828@qq.com;也可以拔打客服电话:4008-655-100;投诉/维权电话:4009-655-100。