vb.net编码规范 vbnet imemode( 四 )


显示给用户的消息要简短而友好 。但要把所有可能的信息都记录下来,以助诊断问题 。注释
别每行代码,每个声明的变量都做注释 。
在需要的地方注释 。可读性强的代码需要很少的注释 。如果所有的变量和方法的命名都很有意义,会使代码可读性很强并无需太多注释 。
行数不多的注释会使代码看起来优雅 。但如果代码不清晰,可读性差,那就糟糕 。
如果应为某种原因使用了复杂艰涩的原理,为程序配备良好的文档和重分的注释 。
对一个数值变量采用不是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 。
关于vb.net编码规范和vbnet imemode的介绍到此就结束了,不知道你从中找到你需要的信息了吗 ?如果你还想了解更多这方面的信息,记得收藏关注本站 。

推荐阅读