欢迎来到天天文库
浏览记录
ID:39571683
大小:117.50 KB
页数:8页
时间:2019-07-06
《某公司c#编程规范》由会员上传分享,免费在线阅读,更多相关内容在教育资源-天天文库。
1、普丰公司编码规范说明C#开发编码规范注记:Pascal大小写形式——所有单词第一个字母大写,其他字母小写。Camel大小写形式——除了第一个单词,所有单词第一个字母大写,其他字母小写。类名使用Pascal大小写形式publicclassHelloWorld{…}方法使用Pascal大小写形式publicclassHelloWorld{voidSayHello(stringname){…}}变量和方法参数使用Camel大小写形式publicclassHelloWorld{inttotalCount=0;
2、voidSayHello(stringname){stringfullMessage="Hello"+name;…}}不要使用匈牙利方法来命名变量。以前,多数程序员喜欢把数据类型作为变量名的前缀而m_作为成员变量的前缀。例如:stringm_sName;intnAge;然而,这种方式在.NET编码规范中是不推荐的。所有变量都用Camel大小写形式,而不是用数据类型和m_来作前缀。用有意义的,描述性的词语来命名变量。别用缩写。用name,address,salary等代替nam,addr,sal。别使用
3、单个字母的变量象i,n,x等。使用index,temp等。用于循环迭代的变量例外:for(inti=0;i4、花括弧({})需和括号外的代码对齐。用一个空行来分开代码的逻辑分组。boolSayHello(stringname){stringfullMessage="Hello"+name;DateTimecurrentTime=DateTime.Now;stringmessage=fullMessage+",thetimeis:"+currentTime.ToShortTimeString();MessageBox.Show(message);if(…){//Dosomething//…returnfalse5、;}returntrue;}这段代码看起来比上面的好:boolSayHello(stringname){stringfullMessage="Hello"+name;DateTimecurrentTime=DateTime.Now;stringmessage=fullMessage+",thetimeis:"+currentTime.ToShortTimeString();MessageBox.Show(message);if(…){//Dosomething//…returnfalse;}retur6、ntrue;}在一个类中,各个方法需用一空行,也只能是一行分开。花括弧需独立一行,而不象if,for等可以跟括号在同一行。好:if(…){//Dosomething普丰公司编码规范说明}不好:if(…){//Dosomething}在每个运算符和括号的前后都空一格。好:if(showResult==true){for(inti=0;i<10;i++){//}}不好:if(showResult==true){for(inti=0;i<10;i++){//}}良好的编程习惯遵从以下良好的习惯以写出好程序。7、避免使用大文件。如果一个文件里的代码超过300~400行,必须考虑将代码分开到不同类中。避免写太长的方法。一个典型的方法代码在1~25行之间。如果一个方法发代码超过25行,应该考虑将其分解为不同的方法。方法名需能看出它作什么。别使用会引起误解的名字。如果名字一目了然,就无需用文档来解释方法的功能了。好:voidSavePhoneNumber(stringphoneNumber){//Savethephonenumber.}不好://Thismethodwillsavethephonenumber.vo8、idSaveData(stringphoneNumber){//Savethephonenumber.}一个方法只完成一个任务。不要把多个任务组合到一个方法中,即使那些任务非常小。普丰公司编码规范说明好://Savetheaddress。SaveAddress(address);//Sendanemailtothesupervisortoinformthattheaddressisupdated.SendEmail(address,email);void
4、花括弧({})需和括号外的代码对齐。用一个空行来分开代码的逻辑分组。boolSayHello(stringname){stringfullMessage="Hello"+name;DateTimecurrentTime=DateTime.Now;stringmessage=fullMessage+",thetimeis:"+currentTime.ToShortTimeString();MessageBox.Show(message);if(…){//Dosomething//…returnfalse
5、;}returntrue;}这段代码看起来比上面的好:boolSayHello(stringname){stringfullMessage="Hello"+name;DateTimecurrentTime=DateTime.Now;stringmessage=fullMessage+",thetimeis:"+currentTime.ToShortTimeString();MessageBox.Show(message);if(…){//Dosomething//…returnfalse;}retur
6、ntrue;}在一个类中,各个方法需用一空行,也只能是一行分开。花括弧需独立一行,而不象if,for等可以跟括号在同一行。好:if(…){//Dosomething普丰公司编码规范说明}不好:if(…){//Dosomething}在每个运算符和括号的前后都空一格。好:if(showResult==true){for(inti=0;i<10;i++){//}}不好:if(showResult==true){for(inti=0;i<10;i++){//}}良好的编程习惯遵从以下良好的习惯以写出好程序。
7、避免使用大文件。如果一个文件里的代码超过300~400行,必须考虑将代码分开到不同类中。避免写太长的方法。一个典型的方法代码在1~25行之间。如果一个方法发代码超过25行,应该考虑将其分解为不同的方法。方法名需能看出它作什么。别使用会引起误解的名字。如果名字一目了然,就无需用文档来解释方法的功能了。好:voidSavePhoneNumber(stringphoneNumber){//Savethephonenumber.}不好://Thismethodwillsavethephonenumber.vo
8、idSaveData(stringphoneNumber){//Savethephonenumber.}一个方法只完成一个任务。不要把多个任务组合到一个方法中,即使那些任务非常小。普丰公司编码规范说明好://Savetheaddress。SaveAddress(address);//Sendanemailtothesupervisortoinformthattheaddressisupdated.SendEmail(address,email);void
此文档下载收益归作者所有