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

 规范 编码 C# 
永远别设想你的代码是在“C:”盘运行。你不会知道，一些用户在网络或“Z:”盘运行程序。 
应用程序启动时作些“自检”并确保所需文件和附件在指定的位置。必要时检查数据库连接。出现任何问题给用户一个友好的提示。 
如果需要的配置文件找不到，应用程序需能自己创建使用默认值的一份。 
如果在配置文件中发现错误值，应用程序要抛出错误，给出提示消息告诉用户正确值。 
错误消息需能帮助用户解决问题。永远别用象“应用程序出错”，“发现一个错误” 等错误消息。而应给出象“更新数据库失败。请确保登陆id和密码正确。”的具体消息。 
显示错误消息时，除了说哪里错了，还应提示用户如何解决问题。不要用象“更新数据库失败。”这样的，要提示用户怎么做：“更新数据库失败。请确保登陆id和密码正确。”
显示给用户的消息要简短而友好。但要把所有可能的信息都记录下来，以助诊断问题。 
注释
别每行代码，每个声明的变量都做注释。 
在需要的地方注释。可读性强的代码需要很少的注释。如果所有的变量和方法的命名都很有意义，会使代码可读性很强并无需太多注释。 
行数不多的注释会使代码看起来优雅。但如果代码不清晰，可读性差，那就糟糕。 
如果应为某种原因使用了复杂艰涩的原理，为程序配备良好的文档和重分的注释。 
对一个数值变量采用不是0,-1等的数值初始化，给出选择该值的理由。 
简言之，要写清晰，可读的代码以致无须什么注释就能理解。 
对注释做拼写检查，保证语法和标点符号的正确使用。
异常处理
不要“捕捉了异常却什么也不做”。如果隐藏了一个异常，你将永远不知道异常到底发生了没有。
发生异常时，给出友好的消息给用户，但要精确记录错误的所有可能细节，包括发生的时间，和相关方法，类名等。 
只捕捉特定的异常，而不是一般的异常。
好： 
void ReadFromFile ( string fileName ) 

{  

try  

{   

// read from file.