您所在的位置:开发 > .NET > C#编码规范和编程好习惯(3)

C#编码规范和编程好习惯(3)

2007-03-06 13:42 杨贺宏 Csdn 我要评论(0) 字号:T | T
一键收藏,随时查看,分享好友!

本文讲述了C#编码的命名惯例和规范,比如文件名要和类名匹配,一些良好的编程习惯,相关注释和异常处理。供大家参考!

AD:

永远别设想你的代码是在“C:”盘运行。你不会知道,一些用户在网络或“Z:”盘运行程序。

应用程序启动时作些“自检”并确保所需文件和附件在指定的位置。必要时检查数据库连接。出现任何问题给用户一个友好的提示。

如果需要的配置文件找不到,应用程序需能自己创建使用默认值的一份。

如果在配置文件中发现错误值,应用程序要抛出错误,给出提示消息告诉用户正确值。

错误消息需能帮助用户解决问题。永远别用象“应用程序出错”,“发现一个错误” 等错误消息。而应给出象“更新数据库失败。请确保登陆id和密码正确。”的具体消息。

显示错误消息时,除了说哪里错了,还应提示用户如何解决问题。不要用象“更新数据库失败。”这样的,要提示用户怎么做:“更新数据库失败。请确保登陆id和密码正确。”

显示给用户的消息要简短而友好。但要把所有可能的信息都记录下来,以助诊断问题。

注释

别每行代码,每个声明的变量都做注释。

在需要的地方注释。可读性强的代码需要很少的注释。如果所有的变量和方法的命名都很有意义,会使代码可读性很强并无需太多注释。

行数不多的注释会使代码看起来优雅。但如果代码不清晰,可读性差,那就糟糕。

如果应为某种原因使用了复杂艰涩的原理,为程序配备良好的文档和重分的注释。

对一个数值变量采用不是0,-1等的数值初始化,给出选择该值的理由。

简言之,要写清晰,可读的代码以致无须什么注释就能理解。

对注释做拼写检查,保证语法和标点符号的正确使用。

异常处理

不要“捕捉了异常却什么也不做”。如果隐藏了一个异常,你将永远不知道异常到底发生了没有。

发生异常时,给出友好的消息给用户,但要精确记录错误的所有可能细节,包括发生的时间,和相关方法,类名等。

只捕捉特定的异常,而不是一般的异常。

好:

void ReadFromFile ( string fileName ) 
{  
try  
{   
// read from file.  
    }  
catch (FileIOException ex)  
{   
// log error.   
//  re-throw exception depending on your case.   
        throw;  

}

不好:

void ReadFromFile ( string fileName ) 
{  
try  
{   
// read from file.  
    }  
catch (Exception ex)   
{   
// Catching general exception is bad... we will never know whether it   
// was a file error or some other error.      
// Here you are hiding an exception.    
// In this case no one will ever know that an exception happened.   
        return "";    

}

不必在所有方法中捕捉一般异常。不管它,让程序崩溃。这将帮助你在开发周期发现大多数的错误。

你可以用应用程序级(线程级)错误处理器处理所有一般的异常。遇到”以外的一般性错误“时,此错误处理器应该捕捉异常,给用户提示消息,在应用程序关闭或 用户选择”忽略并继续“之前记录错误信息。

不必每个方法都用try-catch。当特定的异常可能发生时才使用。比如,当你写文件时,处理异常FileIOException.

别写太大的 try-catch 模块。如果需要,为每个执行的任务编写单独的 try-catch 模块。 这将帮你找出哪一段代码产生异常,并给用户发出特定的错误消息。

如果应用程序需要,可以编写自己的异常类。自定义异常不应从基类SystemException派生,而要继承于IApplicationException。

不好:

 // Save the address. 
SaveAddress (  address ); 
// Send an email to the supervisor to inform that the address is updated. 
SendEmail ( address, email );    
void SaveAddress ( string address ) 
{  
// Save the address.  // ... 
}  
void SendEmail ( string address, string email ) 
{  
// Send an email to inform the supervisor that the address is changed.  // ... 
}

好:

 // Save address and send an email to the supervisor to inform that the address is updated. 
SaveAddress ( address, email ); 
void SaveAddress ( string address, string email ) 
{  
// Job 1.  
// Save the address.  
// ... 
// Job 2.  
// Send an email to inform the supervisor that the address is changed.  
// ... 
}

(责任编辑 火凤凰 sunsj@51cto.com  QQ:34067741  TEL:(010)68476636-8007)


内容导航

分享到:

网友评论TOP5

查看所有评论(

提交评论

  1. 专题:JVM编程语言,你的选择?
  2. 宅男程序员给老婆课程之11:域模型

文章排行

本月本周24小时

热点专题

更多>>

读书

2006软考上半年试题分析与解答
本书是针对全国计算机技术与软件专业技术资格(水平)考试而编写的,书中详尽分析与解答了2006年上半年的程序员级、软件设计师级

51CTO旗下网站

领先的IT技术网站 51CTO 领先的中文存储媒体 WatchStor 中国首个CIO网站 CIOage 中国首家数字医疗网站 HC3i 移动互联网生活门户 灵客风LinkPhone