不管是在面向过程时代,还是在面向对象时代,任何一个功能都是由若干函数协作来实现的。一个函数由输入、处理和输出组成。实现这个函数的代码段都假定了输入的参数已经满足了若干规则,在执行这个函数时,函数的代码会拿到输入的参数然后执行代理逻辑。下面我们就来看一个函数的代码。
private static void ParseArgs(string[] arguments) { if (_parsedArgs) { return; } if (arguments == null) { arguments = CommandLineArgs; } //命令行格式: const string usage = "[-initial 5] [-level 2]"; for (int i = 0; i这个函数大致的用意是使得一个程序启动时,允许用户在启动程序时可以带上类似“-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一个健壮的函数,需要考虑的问题不仅仅只是正确的功能。上面的这段代码仅仅是考虑了用户输入是正确的情况。当用户输入错误时,以上代码要么出现没有任何友好提示的异常,要么仅给出一个不友好的错误信息。使一个函数达到健壮,在编码时,我们必须谨记:
- 不能假定函数的输入参数是正确,必须检查函数的输入参数是否符合规则;
- 当函数的输入不符合规则时,必须告诉用户错在哪,并告诉用户如何输入正确的参数;
- 考虑代码的可读性,遵循代码规范。
另外,测试时需要确定输入参数的边界,将处于边界内和边界外的参数都测试,以保证函数的参数不正确时函数能给出一个友好的提示。
本文地址:http://www.nowamagic.net/librarys/veda/detail/1685,欢迎访问原出处。