public unsigned short TransMogrify( UFEventLink IncomingLink ) { // // local variables // unsigned short usRc; String sOurEventType; String sTheirEventType; // // beginning of code // usRc = 0; sOurEventType = null; sTheirEventType = null; // // a miracle occurs... // return( usRc ); } // end "TransMogrify"
使用一个“编码标准”文档
如果您有一个编码标准文档，就使用它。您可以在 Internet 上找到许多种编码标准。找到一种简单的、切中要害、并为您留下一定的活动空间的标准。Sun 的网站有一个关于 Java 编程的编码规范的文章（请参阅参考资料），它给出了拥有标准的下列几点理由：
几乎没有软件在整个使用期间都是由原作者维护的。
编码规范改进了软件的可读性，使工程师可以更快和更充分地理解新代码。
如果您将源代码作为产品交付，那么需要保证它有像您创建的所有其他产品一样的包装和整洁性。
即使不赞成“标准”的想法，至少采用这个简单的建议：对变量名使用“匈牙利命名法”，这会使您的代码更容易阅读和维护（有关匈牙利命名法的说明请参阅参考资料）。
保证返回代码的一致性
在调试时有一种会制造麻烦的情况是：调用程序屏蔽（或者覆盖）一个表示错误的返回代码。一定要想好您要向调用您的代码的例程返回什么值，并保证从您所调用的例程返回的所有错误代码都得到恰当处理。如果返回代码n在一个地方意味着一件事，就不要在其他的地方用返回代码n表示另一件事。
对每个例程使用“单点退出”
这一点怎么强调也不过分：对每个例程使用单点退出 —— 就是说，没有多重返回！这是最容易忽视的、也是您可以采用的最好的习惯。如果例程只从一个地方返回，那么就可以用一种非常容易的方法保证在返回前完成所有必要的清理工作，这也使调试更容易。清单 2 显示了一个包含多重返回的代码示例。注意重复代码、甚至忘记“清理”项目（如红色突出显示的文本所示）是多么容易。
1 public String getName( )2 {3 //4 // local variables5 //6 String returnString;789 //10 // beginning of code11 //12 returnString = textField.getText( );13 if ( null == returnstring )14 {15badCount++;16totalCount++;17 return( null )18 }1920 returnString = returnString.trim( );21 if ( returnString.equals( "" ) )22 {23badCount++;24totalCount++;25 return( null );26 }2728totalCount++;29 return( returnString );3031 } // end getName
在第 15 行，badCount增加了，因为getText( )返回null。在第 23 行，badCount代码又重复了。现在想像一下如果这个例子需要完成更复杂的“清理”时会有多混乱。
清单 3 显示了一种更好的方法：
清单 3. 单点退出示例 —— 修正后1 public String getName( )2 {3 //4 // local variables5 //6 String returnString;789 //10 // beginning of code11 //12 returnString = textField.getText( );13 if ( null != returnstring )14 {15 returnString = returnString.trim( );16 if ( returnString.equals( "" ) )17 returnString = null;18 }1920 //21 // "cleanup"22 //23 if ( null == returnString )24 badCount++;25 totalCount++;2627 return( returnString );2829 } // end getName
延伸阅读
文章来源于领测软件测试网 https://www.ltesting.net/
