欢迎来到天天文库
浏览记录
ID:18838387
大小:110.50 KB
页数:12页
时间:2018-09-26
《web系统开发实践中整理的常用编程规范》由会员上传分享,免费在线阅读,更多相关内容在教育资源-天天文库。
1、C#编程规范1.0C#编程规范Version1.0C#编程规范1.0目录第一章 概述3规范制定原则3术语定义3Pascal大小写3Camel大小写3文件命名组织31.3.1文件命名31.3.2文件注释3第二章程序注释53.2文档型注释53.4单行注释53.5类注释53.6方法注释5第三章 命名规范65.1类65.2接口65.3参数65.4方法65.5属性(property)75.6常量(const)75.7成员变量75.8静态成员变量75.9控件的事件处理函数7第四章控件命名规则87.1命名方法87.2主要控件名简写对照表8C#编程规范1.0第一章 概述规范制定原则1方便代码的交流和维护。
2、2不影响编码的效率,不与大众习惯冲突。3使代码更美观、阅读更方便。4使代码的逻辑更清晰、更易于理解。术语定义Pascal大小写将标识符的首字母和后面连接的每个单词的首字母都大写。可以对三字符或更多字符的标识符使用Pascal大小写。例如:BackColorCamel大小写标识符的首字母小写,而每个后面连接的单词的首字母都大写。例如:backColor匈牙利命名法基本原则是:变量名=属性+类型+对象描述。在C++中大量使用,从变量名即可快速识别变量的类型和含义。例如:lpszNamelpsz表示LPCSTR32位常量字符串指针。*由于在C#和Java中,编译器有强大的类型检测功能,而脚本语言
3、又都是泛型变量,匈牙利命名法的属性前缀就显得多余了,因此现在匈牙利命名法基本已经弃用。文件命名组织1.3.1文件命名1文件名遵从Pascal命名法,无特殊情况,扩展名小写。2使用统一而又通用的文件扩展名:C#类.cs1.3.2文件注释1在每个文件头必须包含以下注释说明/*----------------------------------------------------------------//Copyright(C)2004XXXX有限公司//版权所有。////文件名://文件功能描述://////创建标识:包括人员和日期信息C#编程规范1.0////修改标识://修改描述:///
4、/修改标识://修改描述://----------------------------------------------------------------*/文件功能描述只需简述,具体详情在类的注释中描述。创建标识和修改标识由创建或修改人员的拼音或英文名加日期组成。如:LiSi20040408一天内有多个修改的只需做一个在注释说明中做一个修改标识就够了。在所有的代码修改处加上修改标识的注释。第二章程序注释在程序逻辑的关键位置,比如if…else…,要为每个分支都添加注释。使用算法,比如起泡排序,也需要使用注释说明一下。3.2文档型注释///MyMethodisamet
5、hodintheMyClassclass.///Here'showyoucouldmakeasecondparagraphinadescription.//////forinformationaboutoutputstatements./////////publicstaticvoidMyMethod(intInt1){}3.4单行注释//注释语句privateint_number;3.5类注释///6、y>///Thisclassisthecode-behindloginpage.///Handlesomeeventfrompage.C#编程规范1.0///@authorYuYang///@version1.00Date:2013/12/04///publicpartialclassLogin:System.Web.UI.Page{}3.5方法注释//////Thisfunctionisusedtocheckthevalidityofuserby///invokingtheinterfaceofUMmodule//////7、amname="userName">theaccountofuser///thepasswordofuser///true:thecurrentuserisvalid///false:thecurrentuserisinvalid///returns>privateboolIsValidUser(stringuserName
6、y>///Thisclassisthecode-behindloginpage.///Handlesomeeventfrompage.C#编程规范1.0///@authorYuYang///@version1.00Date:2013/12/04///publicpartialclassLogin:System.Web.UI.Page{}3.5方法注释//////Thisfunctionisusedtocheckthevalidityofuserby///invokingtheinterfaceofUMmodule//////7、amname="userName">theaccountofuser///thepasswordofuser///true:thecurrentuserisvalid///false:thecurrentuserisinvalid///returns>privateboolIsValidUser(stringuserName
7、amname="userName">theaccountofuser///thepasswordofuser///true:thecurrentuserisvalid///false:thecurrentuserisinvalid///returns>privateboolIsValidUser(stringuserName
此文档下载收益归作者所有