易忽略的程序风格

文章作者 100test 发表时间 2007:03:26 17:25:42
来源 100Test.Com百考试题网

计算机等级考试训练软件《百宝箱》

良好的习惯对于人的成长是非常重要的，良好的编程习惯对于我们编程能力的提高也是非常重要的。我们编程时要有良好的风格，源程代码的逻辑简明清晰，易读易懂是好程序的重要标准。
其实编程的过程中最容易忽略的还是程序的“风格”。这些东东有时让人挺烦的，刚刚放射出光茫的思想似乎被约束住了，本来是灵感发现，还要在后面罗索上半天。
程序需要风格吗？让我们的程序写得更加平易近人，更加生动对我们的编程是大有益处的。对我们的程序学习也能起到事半功倍的作用。编程过程中遵守的不成文的标准，对于我们和他人的交流和自己的再学习都是有益无害的。毕竟有时我们写的程序不是只给自己看的，也不是一时兴起，不管以后。
好的编码可使源代码的可读性强且意义清楚，与其他语言约定相一致，并且尽可能直观。我们自己一眼能看出个大概，在别人眼中也不至于成为千古奇书。下面以VB为例,对程序风格做一下全面的概述，希望对您的编程水平的提高有所帮助。
--------------------------------------------------------
一、程序内部文档应具备的规则
1、标识符应含有含义鲜明的文字。
含义鲜明的文字，能正确地提示程序对象所代表的实体。这对于帮助阅读者理解程序是非常重要的。如果用缩写的形式，那么缩写规则应该一致，并且应该给每个名字加注解。在VB中，主要有如下的约定：
（一）对象命名约定
应该使用一致的前缀来命名对象，使人们容易识别对象的类型。例如我们常用控件CommandButton(命令按钮)可用cmd做为其前缀。Form以frm,Image以 img ,Label以 lbl,List Box 以lst,PictureBox以 pic,Timer以 tmr，等等，在我们编程的过程中，我们看到下面的名称cmdExit我们就知道这一定是一个命令按钮了。如果是第三方提供的控件，我们的说明最好要清晰地标出制造商的名称，以区别于我们的常用控件。
（二）常量和变量命名约定
除了控件以外，常量和变量也是我们编程过程中经常遇到的，我们和他们打交道也是通过名字。
（1）给变量加范围前缀
变量按其作用范围可分做三类，过程级，模块级和全局，所以我们在编程的过程中应将三者加以区别。我们在使用变量时，为了更好地体现代码重用和可维护原则，其定义范围应尽量缩小，这样将使我们的应用程序更加容易理解和易于控制。在VB应用程序中，只有当没有其他方便途径在窗体间共享数据时才使用全局变量。当使用全局变量时，在一个单一模块中声明它们，并按功能分组，给模块取一个有意义的名字。较好的编码习惯是尽可能地定模块化的代码。除了全局变量，过程和函数应该仅对传递给它们的的对象操作。在过程中使用的全局变量应该在过程起始处的声明部分标识出来。变量的作用范围前缀如下：全局 g(global) ,模块级 m(model)，本地过程不需要使用。例如：gintFlag,表示全局整型变量，mstrPassword,可表示模块级字符型变量。
（2）声明所有变量原则。声明所有变量将会节省编程时间，键入错误将大大减少，我们可在程序开始写上如下语句：
Option Explicit
该语句要求在程序中声明所有变量。
（3）变量数据类型声明。可通过下面的前缀来做为变量的数据类标志。
Boolean bln
Byte byt
Double dbl
Integer int
String str
（4）常量。常量的命名，可遵循与变量命名大体相同的原则。
（5）对变量和过程名作出描述。变量或过程名的主体应该使用大小写混合的形式，并且应该足够长以描述它的作用。而且，函数名应以一个动词开头。如JudgeDialog。

VB编程过程中，主要有如下约定。
2、适当的注解
注解是程序员和程序读者通信的重要手段，正确的注解非常有助于对程序的理解。VB中代码注解约定如下：所有的过程和函数都应该以描述这段过程的功能的一段简明的注释开始，说明该程序是干什么的，至于是如何做的，也就是编程的细节，最好不要包括。因为可能日后我们要修改程序，这样做会带来不必要的注释维护工作，如果不修改，将提供误导信息，可能成为错误的注释。因为代码本身和后面程序中的注释将起到相应的说明作用。
过程中的注释块应该包括如下标题：
小节 描述内容
目的 该过程完成什么
假设 列出每个外部变量、控件、打开文件或其他不明显元素
效果 列出每个被影响的外部变量、控件或文件及其作用（只有当它不明显时）
输入 每一个可能不明显的参数。
返回 函数返回值的说明
格式化代码
（1）标准的，基于制表位的嵌套应该包括一个嵌注释，来描述该变量的使用。
（2）变量、控件及过程的命名应该足够清楚，使得只有复杂的执行细节才需要嵌入注释。
（3）.bas 模块包含包含工程的VB一般常量声明，在其起始处，应包括程序的综述，列举主要数据对象，过程、算法、对话、数据库及系统需求。
3、程序的视觉组织
程序的视觉组织可用阶梯式，结构化的程序风格对于我们实际编程也很有意义，可极大地改善代码的可读性。主要有代码注释和一致性缩进。

-------------------------------------------------------------------
二、数据说明
数据结构的组织和复杂程序是在设计期间就已经确定了的，然而数据说明的风格却是在写程序时确定的。为了使数据更容易理解和维护，有一些比较简单的原则应该遵循。
1、数据说明的次序应该标准化。有次序就容易查阅。因此能够加速测试、调试和维护的过程。当多个变量名在一个语句中说明时，应按字母顺序排列这些变量。
2、数据结构复杂时，应加以说明其特点和实现方法。