1 / 26
文档名称:

C#代码规范.doc

格式:doc   大小:208KB   页数:26页
下载后只包含 1 个 DOC 格式的文档,没有任何的图纸或源代码,查看文件列表

如果您已付费下载过本站文档,您可以点这里二次下载

分享

预览

C#代码规范.doc

上传人:changjinlai 2020/9/10 文件大小:208 KB

下载得到文件列表

C#代码规范.doc

文档介绍

文档介绍:#代码的标准、约定和指南。它以安全可靠的软件工程原则为基础,使代码易于理解、维护和增强,提高生产效率。同时,将带来更大的一致性,使软件开发团队的效率明显提高。#源代码,为详细设计,代码编写和代码审核提供参考和依据。:要,建议,避免,不要,表示需要遵循的级别。文档中会以粗体表示。对于应遵循的规范,前面会以“Ö”来表示,对不好的做法前面会以“´”来表示:要:描述必须遵循的规范。例如:异常类要以“Exception”做为后缀;建议:描述在一般情况下应该遵循的规范,但如果完全理解规范背后的道理,并有很好的理由不遵循它时,也不畏惧打破常规。例如:强制类型转换时,在类型和变量之间建议加一空格。不要:描述一些几乎绝对绝不应该违反的规范。例如:每个函数有效代码(不包括注释和空行)长度不要超过50行。避免:与建议相对,一般情况下应该遵循,但有很好的理由时也可以打破。例如:避免块内部的变量与它外部的变量名相同。对一些规范内容一并提供了示例代码。。。,来增加代码的可读性。在在类,接口以及彼此之间要有两行空行:在下列情况之间要有一行空行:方法之间;局部变量和它后边的语句之间;方法内的功能逻辑部分之间;(不包括注释和空行)长度不要超过50行。.“{”,“}”开括号“{”要放在块的所有者的下一行,单起一行;闭括号“}”要单独放在代码块的最后一行,单起一行。,如超过则应换行,换行后的代码应该缩进一个Tab。。括号应该和它前边的关键词留有空格,如:while(true){};但是方法名和左括号之间不要有空格。参数之间的逗号后要加一空格。如:method1(inti1,inti2)for语句里的表达式之间要加一空格。如:for(expr1;expr2;expr3)二元操作符和操作数之间要用空格隔开。如:i+c;强制类型转换时,在类型和变量之间要加一空格。如:(int)i;;保持注释的简洁,不是任何代码都需要注释的,过多的注释反而会影响代码的可读性。注释不要包括其他的特殊字符。建议先写注释,后写代码,注释和代码一起完成如果语句块(比如循环和条件分枝的代码块)代码太长,嵌套太多,则在其结束“}”要加上注释,标志对应的开始语句。如果分支条件逻辑比较复杂,也要加上注释。在VS2005环境中通过配置工程编译时输出XML文档文件可以检查注释的完整情况,如果注释不完整会报告编译警告;,类,方法,算法等,放在所描述对象的前边。具体格式以IDE编辑器输入“///”自动生成的格式为准,另外再附加我们自定义的格式,如下所列:///<Remark>作者,创建日期,修改日期</Remark>对类和接口的注释必须加上上述标记,,对代码,变量,流程等进行说明。整个注释占据一行。,放在代码的同行,但是要与代码之间有足够的空间,便于分清。例:intm=4;//注释如果一个程序块内有多个尾随注释,每个注释的缩进要保持一致。.程序修改注释新增代码行的前后要有注释行说明,对具体格式不作要求,但必须包含作者,新增时间,新增目的。在新增代码的最后必须加上结束标志;删除代码行的前后要用注释行说明,删除代码用注释原有代码的方法。注释方法和内容同新增;删除的代码行建议用#regionXXX

最近更新

2024年年度医生个人工作总结 12页

肾与输尿管结核的影像诊断 49页

基于灰度投票和高斯混合模型的眼底视网膜血管.. 2页

基于漏磁原理的钢丝绳典型缺陷检测实验研究的.. 2页

2024年年会老板致辞(集合15篇) 33页

基于混合流水作业组织的集装箱码头装卸集成调.. 2页

2024年年会员工邀请函范文(通用5篇) 3页

基于活动的用例描述元模型研究的开题报告 2页

基于汇率-利率联动性的汇率市场风险度量研究的.. 2页

2024年平行四边形面积教学反思 28页

基于模糊规划的供应商选择问题研究的开题报告.. 2页

基于极值理论的融资融券保证金设定研究中期报.. 2页

基于机器视觉的线缆姿态校正平台的设计与研究.. 2页

2024年帮扶协议书汇总5篇 9页

肩关节周围炎课件 13页

2024年师范生实习日记模板十篇 22页

股胫内侧关节炎和冠状韧带损伤治疗分析课件 43页

2024年师德师风考核自我评价(合集4篇) 9页

基于改进卡尔曼滤波算法的SOC估计方法研究的开.. 2页

2023年消防救援站党支部工作总结 4页

教师心得体会师德感悟篇范文2023年 9页

学校食堂6s管理内容和标准四篇 51页

消防工程施工进度计划表格 4页

夹江陶瓷产业发展历程和基本概况 5页

超声科质量控制评分表(共1页) 1页

高速铁路桥梁缺陷整治方案 56页

尊师开示 7页

张宏宝尊师谈养生修炼的利与弊 10页

广义财政论 6页