C#代码规范(湖南大学).doc
11页1、创新课程参考案例铁路局计量管理系统C#代码规范湖南大学软件学院2007年8月文档信息:文档编号MMIS-03文档名称计量系统C#代码规范文档描述该文档详细定义了计量系统开发中的C#代码编写规范,本文档是后续分模块程序编码的规范性文档。VSS中文档存放路径$/学院/软件开发部/计量系统/开发设计文档负责人状态定稿文档变更记录:时间修改人章节描述2007-05-29陈浩所有创建新文档相关文档:文档路径计量系统需求分析说明书$/学院/软件开发部/计量系统/开发设计文档计量系统功能说明书$/学院/软件开发部/计量系统/开发设计文档文档确认与评审记录:审核人审核时间意见备注项目组2005-7-28评审通过用户评审确认目 录1编程风格41.1统一编程风格的意义41.2变量命名规则41.3函数命名规则51.4类命名规则51.5常见语句书写规则61.6注释风格72代码组织73代码优化83.1代码优化的意义83.2函数内的代码优化83.3类内的代码优化93.4类之间的代码优化104调试技巧104.1编译时的错误104.2运行时的错误104.3C#常见问题111 编程风格1.1 统一编程风格的意义 增加开
2、发过程代码的强壮性、可读性、易维护性 减少有经验和无经验开发人员编程所需的脑力工作 为软件的良好维护性打下好的基础 在项目范围内统一代码风格 通过人为以及自动的方式对最终软件应用质量标准 使新的开发人员快速适应项目氛围 支持项目资源的复用:允许开发人员从一个项目区域(或子项目团队)移动到另一个,而不需要重新适应新的子项目团队的氛围 一个优秀而且职业化的开发团队所必需的素质1.2 变量命名规则 前缀(小写字母加下划线)表明变量的作用域,无前缀则表明是局部变量或函数的参数。如: m_xx表示是类的成员变量,控件变量例外 g_xx表示是全局变量,在C#中,也可以理解为在整个项目中都可能用到的静态变量 c_xx或者XX表示是一个常量 用数据类型全称中的关键字母代表特定的数据类型(一个或多个小写字母),如下表。常用数据类型缩写数据类型iintbboolstrstringccharffloatddoubleobobjectlblLabeltxtTextBoxbtnButtoncmbComboBoxmnuMainmenumnuItemMenuItemchkCheckBoxgrdDataGridtmT
3、imerfrmFormpnlPanelgupGroupBoxtvTreeViewrdoRadioButtonlbListBoxtlbToolBardtDateTimecnConnectioncmdCommanddsDataSetdaDataAdapterdvDataViewdbTableDataTabledbReaderDataReaderparamParameterdbRowDataRowdbColDataColumn注:如果模块中只有一个类实例对象,则可以只用简写。如Connection对象可以用cn来命名。1.3 函数命名规则 函数名用首字母大写的英文单词组合表示(如用动词+名词的方法),其中至少有一个动词 应该避免的命名方式 和继承来的函数名一样。即使函数的参数不一样,也尽量不要这么做,除非想要重载它 只由一个动词组成,如:Save、Update。改成如:SaveValue、UpdateDataSet则比较好 函数参数的命名规则 函数参数应该具有自我描述性,应该能够做到见其名而知其意 用匈牙利命名法命名1.4 类命名规则 类的命名通常以父类的简写开头。如:FrmXXX可看出该类
4、从Form中继承而来 类名中尽量不要出现下划线 类变量的命名可以参照,如:FrmXXX frmXXX = new FrmXXX(),即首字母小写即可1.5 常见语句书写规则如下表所示。语句提倡的风格ifif(condition)statements;elsestatements;forfor(initialization; condition; update)statements;foreachforeach(something in collection)statements;switchswitch()case .:break;case :break;default:whilewhile(.)statements;do-whiledostatements;while(condition);try-catchtrystatements;catch(Exception e)handle exception;同一代码块内的不同逻辑块之间应空一行do statement1;do statement2;函数与函数之间至少空一行,但不超三行1.6 注释风格 注释应该正确、简洁、有重点 应该写优
《C#代码规范(湖南大学).doc》由会员小**分享,可在线阅读,更多相关《C#代码规范(湖南大学).doc》请在金锄头文库上搜索。
2020年高考真题——理科综合(全国卷Ⅲ)+Word版含答案
2021年绝味鸭脖策划书
2021年熟食店创业方案
2021年熟食店开店策划
2021年卤菜店创业计划书
2021年周黑鸭网络营销策划方案
东大21年1月考试《现代设计方法》考核作业
谈我国行政管理效率的现状及其改观对策(论文)
单证员考试-备考辅导-复习资料:无贸易背景信用证案分析.docx
土木工程毕业生答辩自述.docx
建筑学毕业后工作状态真实写照.doc
C#代码规范(湖南大学).doc
xx区食药监局2019年工作总结及2020年工作计划
2019年中医院药物维持治疗门诊工人先锋号先进事迹
2019年度xx乡镇林长制工作总结
2019年性艾科工作计划书
2019年人才服务局全国扶贫日活动开展情况总结
关于组工信息选题的几点思考
摘了穷帽子 有了新模样
2019年某集团公司基层党支部书记培训班心得体会
2024-03-27 22页
2024-03-27 2页
2024-03-27 3页
2024-03-27 1页
2024-03-25 23页
2024-03-25 29页
2024-03-25 2页
2024-03-25 3页
2024-03-25 4页
2024-03-25 2页