如何写健壮的代码

简介:

不管是在面向过程时代,还是在面向对象时代,任何一个功能都是由若干函数协作来实现的。一个函数由输入、处理和输出组成。实现这个函数的代码段都假定了输入的参数已经满足了若干规则,在执行这个函数时,函数的代码会拿到输入的参数然后执行代理逻辑。下面我们就来看一个函数的代码。

 

复制代码
 1  private   static   void  ParseArgs( string [] arguments) 
 2 
 3       if  (_parsedArgs) 
 4      { 
 5           return
 6      } 
 7       if  (arguments  ==   null
 8      { 
 9          arguments  =  CommandLineArgs; 
10      } 
11       // 命令行格式: 
12       const   string  usage  =   " [-initial 5] [-level 2] "
13       for  ( int  i  =   0 ; i  <  arguments.Length; i ++
14      { 
15           // 匹配前导符 
16           if  (arguments[i].CompareTo(InitialStartLevelLead)  ==   0
17          { 
18               // step forward 
19               if  ( ++ i < arguments.Length) 
20              { 
21                   // 取值 
22                  _initialBundleStartLevel  =  Convert.ToInt32(arguments[i]); 
23                   continue
24              } 
25               else  
26              { 
27                   goto  fail; 
28              } 
29                  
30          } 
31           if  (arguments[i].CompareTo(StartLevelLead)  ==   0
32          { 
33               // step forward 
34               if  ( ++ <  arguments.Length) 
35              { 
36                   // 取值 
37                  _startLevel  =  Convert.ToInt32(arguments[i]); 
38                   continue
39              } 
40               else  
41              { 
42                   goto  fail; 
43              }
44          } 
45       } 
46      _parsedArgs  =   true
47       return
48  fail: 
49       throw   new  Exception( " Invalid args,usage: " +  usage); 
50  }
复制代码

 

这个函数大致的用意是使得一个程序启动时,允许用户在启动程序时可以带上类似“-initial 5 -level 2”这样的参数来改变程序的行为。估计我们经常会写出类似以上的程序,有时候可能是因为经验不足,有时候可能是偷懒。你可以找出这段小程序有哪些问题吗?

 

下面我使用注释的方式把函数中每一个小细节问题标记一下,如果有遗落也请大家补充。

 

复制代码
private   static   void  ParseArgs( string [] arguments) 

    
if  (_parsedArgs)   // 1 这个参数的命名不符合规则,正确的命名应该是_isArgsParsed,如果想让参数可读性更强,可以再将参数的限定词声明一下,变成_is××ArgsParsed。 
    { 
        
return
    } 
    
if  (arguments  ==   null
    { 
        arguments 
=  GetCommandLineArgs(); 
    } 
    
// 命令行格式: 
     const   string  usage  =   " [-initial 5] [-level 2] "
// 2 硬编码的字符串。
    
for  ( int  i  =   0 ; i  <  arguments.Length; i ++ )   // 3 如果GetCommandLineArgs的返回值为空,则这行代码会出现NullReferenceException;此外,如果arguments.Length大于4个,我们需要给用户提示;如果参数出现重复或者不符合要求,我们也需要给用户提示。 
    { 
        
// 匹配前导符 
         if  (arguments[i].CompareTo(InitialStartLevelLead)  ==   0 // 4 如果arguments[i]允许带空格,则这行代码会产生错误的执行结果 
        { 
            
// step forward 
             if  ( ++ i < arguments.Length) 
            { 
                
// 取值 
                _initialBundleStartLevel  =  Convert.ToInt32(arguments[i]);   // 5 如果arguments[i]不是合法的整数,则这行代码会产生转换失败的异常。 
                 continue
            } 
            
else  
            { 
                
goto  fail; 
            } 
                
        } 
        
if  (arguments[i].CompareTo(StartLevelLead)  ==   0 // 6 问题同3 
        { 
            
// step forward 
             if  ( ++ <  arguments.Length) 
            { 
                
// 取值 
                _startLevel  =  Convert.ToInt32(arguments[i]);   // 7 问题同4 
                 continue
            } 
            
else  
            { 
                
goto  fail; 
            }
        } 
     } 
    _parsedArgs 
=   true
    
return
fail: 
    
throw   new  Exception( " Invalid args,usage: " +  usage);  // 8 异常信息不友好,没有清楚告诉用户是哪一个参数输入有问题,此外在英文文法中,“args”和“usage”中间要空格,另外,给用户的信息不能够随便使用缩写,必须使用完整的词语;硬编码字符串需要放在一个统一的资源文件,并考虑I18N和L10N支持;问题2中的字符串可以直接和这个Exception的字符串直接合并;如果有必要的话,最好重新定义个Exception类型。
}
复制代码

 

一个健壮的函数,需要考虑的问题不仅仅只是正确的功能。上面的这段代码仅仅是考虑了用户输入是正确的情况。当用户输入错误时,以上代码要么出现没有任何友好提示的异常,要么仅给出一个不友好的错误信息。使一个函数达到健壮,在编码时,我们必须谨记:(1)不能假定函数的输入参数是正确,必须检查函数的输入参数是否符合规则;(2)当函数的输入不符合规则时,必须告诉用户错在哪,并告诉用户如何输入正确的参数;(3)考虑代码的可读性,遵循代码规范。另外,测试时需要确定输入参数的边界,将处于边界内和边界外的参数都测试,以保证函数的参数不正确时函数能给出一个友好的提示。


本文转自道法自然博客园博客,原文链接:http://www.cnblogs.com/baihmpgy/archive/2011/07/24/2115270.html,如需转载请自行联系原作者

目录
相关文章
|
8月前
|
算法 程序员 Python
如何写出优美整洁的代码
【4月更文挑战第5天】 编写优美整洁的代码能提升可读性、可维护性和开发效率。遵循命名规范,如使用小写字母和下划线命名变量,驼峰命名法命名函数和类。适当注释代码,但避免过度注释。避免冗余代码,通过函数封装重复逻辑。使用空格和缩进增强代码可读性,遵循PEP 8编码规范。利用异常处理机制处理错误,保持代码简洁。
55 0
|
7月前
|
Java 开发者 UED
异常处理机制:让代码更健壮的秘籍
Java异常处理确保程序健壮性。分为检查性异常(需编译时处理)和运行时异常。使用try-catch-finally结构捕获和管理异常,finally确保资源清理。通过throw抛出异常,throws声明可能抛出的异常。自定义异常增强代码可读性。最佳实践包括精确捕获异常、避免空catch、妥善管理资源。异常处理是提升软件质量的关键。
80 3
|
7月前
|
算法 安全 编译器
【简洁的代码永远不会掩盖设计者的意图】如何写出规范整洁的代码
【简洁的代码永远不会掩盖设计者的意图】如何写出规范整洁的代码
61 1
|
8月前
|
存储 缓存 运维
如何写好代码?一个提升代码可读性的小技巧
如何提高代码的可读性,使得代码变得整洁,甚至赏心悦目。本文会从“控制流”的角度分享一下作者对提高代码可读性的一些思考。
|
设计模式 人工智能 Java
一个可读性高的代码对程序员有多重要
人们都以为编写任何程序员都能够阅读和理解的代码是软件开发人员的固有技能。事实上只有20%的程序员具备这种能力。
|
8月前
|
算法 程序员
编程遗产:祖传代码
编程遗产:祖传代码
|
前端开发 JavaScript 程序员
如何编写高质量代码
如何编写高质量代码
96 0
|
8月前
|
前端开发 测试技术
代码注释怎么写:让你的代码更易维护
在编程中,有一种无声的艺术,那就是代码注释。这可能看起来微不足道,但其实非常关键。它不仅有助于他人理解你的代码,也是自我表达的一种方式。
|
8月前
|
安全 NoSQL 程序员
【年度征文 健壮代码 心得体会】 如何编写健壮的C++代码
【年度征文 健壮代码 心得体会】 如何编写健壮的C++代码
123 0

热门文章

最新文章