《第25讲高质量编码标准精选文档.ppt》由会员分享，可在线阅读，更多相关《第25讲高质量编码标准精选文档.ppt（15页珍藏版）》请在taowenge.com淘文阁网|工程机械CAD图纸|机械工程制图|CAD装配图下载|SolidWorks_CaTia_CAD_UG_PROE_设计图分享下载上搜索。
1、第第25讲高高质量量编码标准准本讲稿第一页，共十五页高质量的编码标准能使程序便于交流和维护，同时也让高质量的编码标准能使程序便于交流和维护，同时也让程序的美感增强，一个良好的编码结构往往是体现程序程序的美感增强，一个良好的编码结构往往是体现程序员编程功底很好的体现，也是一个开发团队文化建设的员编程功底很好的体现，也是一个开发团队文化建设的任务之一。任务之一。编码的习惯和规范在编程中占据着重要的地位，是一个编码的习惯和规范在编程中占据着重要的地位，是一个程序员编程文化修养的另一种体现。良好的编码习惯和程序员编程文化修养的另一种体现。良好的编码习惯和统一的风格有利于降低代码的出错率，也便于代码的调
2、统一的风格有利于降低代码的出错率，也便于代码的调试、交流和维护。规范编码大大增强了代码的可读性，试、交流和维护。规范编码大大增强了代码的可读性，团队的可协作性。团队的可协作性。本讲稿第二页，共十五页 成对编码和缩进编码，成对编码的基本思想非常简单，成对编码和缩进编码，成对编码的基本思想非常简单，但是也是最常用的。其核心就是但是也是最常用的。其核心就是“两两成对两两成对”，这里，这里主要是指括号成对。主要是指括号成对。因为成对现象在因为成对现象在C语言家族中是极为普遍的，任何一个函语言家族中是极为普遍的，任何一个函数、方法、类的函数体都是以成对的数、方法、类的函数体都是以成对的“”所括起来的。所
3、括起来的。从这一点可以给出成对编码的基本方法。从这一点可以给出成对编码的基本方法。本讲稿第三页，共十五页下面以编写一个下面以编写一个“Hello World”程序为例讲述成对编码。程序为例讲述成对编码。（1）第一步，输入函数名后，打一个）第一步，输入函数名后，打一个“”回车后立即打个回车后立即打个“”。static void Main(string args)/输完这个输完这个“”左括号就后回车左括号就后回车/在这里写代码在这里写代码（2）将光标移至上一行末，然后回车，再按下一）将光标移至上一行末，然后回车，再按下一Tab键，键，static void Main(string args)/可以
4、在两个括号之间进行编码。可以在两个括号之间进行编码。/写这句之前要按写这句之前要按Tab键一下，当然有的开发工具可能做好了键一下，当然有的开发工具可能做好了.Console.WriteLine(“Hello World”);本讲稿第四页，共十五页 缩进编码能让代码结构的层次感突出，同时它便于查错，缩进编码能让代码结构的层次感突出，同时它便于查错，也增加了程序的美感。其核心就是用也增加了程序的美感。其核心就是用TAB键缩进。不用键缩进。不用SPACES（空格）键。注释和代码对齐，花括弧（空格）键。注释和代码对齐，花括弧“”“”需和括号外的代码对齐。并且使用一个空行来需和括号外的代码对齐。并且使用
5、一个空行来分开代码的逻辑分组。分开代码的逻辑分组。在一个类中，各个方法都需要用一空行，并且也只能是一在一个类中，各个方法都需要用一空行，并且也只能是一行分开。两个对称的花括弧需要独立一行，而不象行分开。两个对称的花括弧需要独立一行，而不象if、for等可以跟括号在同一行，并且在每个运算符和括号的前后等可以跟括号在同一行，并且在每个运算符和括号的前后都空一格。都空一格。本讲稿第五页，共十五页 代码的注释有利于代码的维护、修改和阅读。注释上增代码的注释有利于代码的维护、修改和阅读。注释上增加编写代码的时间、修改代码的时间以及修改前代码的属加编写代码的时间、修改代码的时间以及修改前代码的属性值。如果
6、是多人协作，笔者建议还加上修改者的名字，性值。如果是多人协作，笔者建议还加上修改者的名字，如果一直频繁的进行修改代码，那就需要进行一下版本控如果一直频繁的进行修改代码，那就需要进行一下版本控制了。当然，这样一直改下去将带来很多的垃圾代码，代制了。当然，这样一直改下去将带来很多的垃圾代码，代码文档很大也不是件好事，那就需要定期的整理归档，保码文档很大也不是件好事，那就需要定期的整理归档，保持文档的时效性。注释代码在不同的语言中会有些差别，持文档的时效性。注释代码在不同的语言中会有些差别，大多数语言都支持两种比较流行的注释，即大多数语言都支持两种比较流行的注释，即/注释和注释和/*/对称注释。对称
7、注释。本讲稿第六页，共十五页 在进行注释代码时，并不是要将每行代码、每个声明的变在进行注释代码时，并不是要将每行代码、每个声明的变量都做注释，如果是通用的、简单的、可读性强的代码，量都做注释，如果是通用的、简单的、可读性强的代码，那就需要很少的注释。在复杂语句或一些算法实现中，一那就需要很少的注释。在复杂语句或一些算法实现中，一定要写注释。例如所有的变量和方法的命名都很有意义，定要写注释。例如所有的变量和方法的命名都很有意义，能见名知意，那就无需太多注释。能见名知意，那就无需太多注释。注意：虽然在上述讲解中，笔者提及到在注释代码时，不注意：虽然在上述讲解中，笔者提及到在注释代码时，不要每行代码
8、、每个声明的变量都注释，但是在本书中的实要每行代码、每个声明的变量都注释，但是在本书中的实例代码中，基本上全都注释了，这是为了使读者在阅读时例代码中，基本上全都注释了，这是为了使读者在阅读时便于学习。便于学习。本讲稿第七页，共十五页 良好的命名，能让代码看起来更美，可读性更好，并在开良好的命名，能让代码看起来更美，可读性更好，并在开发过程中便于团队的合作，无论是对自己和他人都有好处，发过程中便于团队的合作，无论是对自己和他人都有好处，所以读者应该注重命名规范的学习。所以读者应该注重命名规范的学习。笔者介绍三种很常用的命名法：骆驼命名法、匈牙利命笔者介绍三种很常用的命名法：骆驼命名法、匈牙利命名
9、法和帕斯卡命名法。它们各有优点，各自用在不同的场名法和帕斯卡命名法。它们各有优点，各自用在不同的场合，读者可根据自己的实际需要，在开发的过程中进行选合，读者可根据自己的实际需要，在开发的过程中进行选择。择。本讲稿第八页，共十五页 骆驼式命令法：当看到一个变量名中有大写字母也有小写字母时，骆驼式命令法：当看到一个变量名中有大写字母也有小写字母时，那就可能是骆驼式命名法。就像它的名称所表示的意思那样，是那就可能是骆驼式命名法。就像它的名称所表示的意思那样，是指混合使用大小写字母来构成变量和函数的名字，也可能是在数指混合使用大小写字母来构成变量和函数的名字，也可能是在数据库名称和表名的命名中，骆驼式
10、命名最为常见，也很规范。据库名称和表名的命名中，骆驼式命名最为常见，也很规范。提示：分别用骆驼式命名法和下划线法命名的同一个函数：提示：分别用骆驼式命名法和下划线法命名的同一个函数：printStudentInformation()；print_Student_Information()；第一个函数名使用了骆驼式；第一个函数名使用了骆驼式命名法，函数名中的每一个逻辑断点都有一个大写字母标记；第命名法，函数名中的每一个逻辑断点都有一个大写字母标记；第二个函数名使用了下划线法，函数名中的每一个逻辑断点都有一二个函数名使用了下划线法，函数名中的每一个逻辑断点都有一个下划线标记。骆驼式命名法能很好的见
11、名知意。个下划线标记。骆驼式命名法能很好的见名知意。本讲稿第九页，共十五页 骆驼式命名法越来越流行了，特别是在数据库系统开发中，非骆驼式命名法越来越流行了，特别是在数据库系统开发中，非常流行，也很科学。在许多新的函数库和常流行，也很科学。在许多新的函数库和Windows操作系统的操作系统的环境中，它都使用得当相多。在另一方面，下划线法是环境中，它都使用得当相多。在另一方面，下划线法是C语言语言出现以后才开始流行起来的，因此在许多旧的程序和出现以后才开始流行起来的，因此在许多旧的程序和UNIX操系操系统的环境中，它的使用还是非常普遍的。统的环境中，它的使用还是非常普遍的。下面是分别用骆驼式命名法
12、和下划线法命名的同一个函数：下面是分别用骆驼式命名法和下划线法命名的同一个函数：printBookInfo()；print_Book_Info()；第一个函数名使用了骆驼式命名法，函数名中的每一个逻辑断第一个函数名使用了骆驼式命名法，函数名中的每一个逻辑断点都有一个大写字母来标记；点都有一个大写字母来标记；第二个函数名使用了下划线法，函数名中的每一个逻辑断点都第二个函数名使用了下划线法，函数名中的每一个逻辑断点都有一个下划线来标记，它们之间就像是组合关系一样。有一个下划线来标记，它们之间就像是组合关系一样。本讲稿第十页，共十五页 匈牙利命名法：它广泛应用于匈牙利命名法：它广泛应用于Window
13、s平台的环境中。平台的环境中。Windows应用程序开发中用到的变量、包括宏的命名规应用程序开发中用到的变量、包括宏的命名规则大都是匈牙利命名法，如果学习过则大都是匈牙利命名法，如果学习过MFC的读者就能体的读者就能体会到，这种命名技术是由一位会到，这种命名技术是由一位Microsoft公司的程序员提公司的程序员提出的，名叫查尔斯西蒙尼（出的，名叫查尔斯西蒙尼（Charles Simonyi）。）。匈牙利命名法通过在变量名前加上相应的小写字母的符匈牙利命名法通过在变量名前加上相应的小写字母的符号标识作为前缀，这些标识往往能反映出变量的数据类型，号标识作为前缀，这些标识往往能反映出变量的数据类型
14、，并且标识出变量的作用域，这些符号可以多个同时使用，并且标识出变量的作用域，这些符号可以多个同时使用，顺序如下图所示。顺序如下图所示。本讲稿第十一页，共十五页 例如：例如：m_lpszStr，表示指向一个以，表示指向一个以0字符结尾的字符串字符结尾的字符串的长指针成员变量。匈牙利命名法的关键是：标识符的名的长指针成员变量。匈牙利命名法的关键是：标识符的名字以一个或多个小写字母开头作为前缀；前缀之后是首字字以一个或多个小写字母开头作为前缀；前缀之后是首字母大写的一个单词或多个单词组合，该单词要指明变量的母大写的一个单词或多个单词组合，该单词要指明变量的用途。见名知意并且知道了数据类型。用途。见名
15、知意并且知道了数据类型。关于匈牙利命名法的一些规则，见书中表关于匈牙利命名法的一些规则，见书中表7.1所示。所示。本讲稿第十二页，共十五页 避免使用大文件也是一种良好的编程习惯。如果在一个避免使用大文件也是一种良好的编程习惯。如果在一个源文件里的代码超过源文件里的代码超过300400行，那笔者建议考虑将代行，那笔者建议考虑将代码分开到不同类中。对于函数或者方法，避免写太长。一码分开到不同类中。对于函数或者方法，避免写太长。一个典型的方法代码在个典型的方法代码在125行之间。如果一个方法发代码行之间。如果一个方法发代码超过超过25行，应该考虑将其功能分解，然后再合。在命名方行，应该考虑将其功能分
16、解，然后再合。在命名方法名的时候，遵循规范的命名方法，做到能见名知意。法名的时候，遵循规范的命名方法，做到能见名知意。本讲稿第十三页，共十五页 帕斯卡命名法与骆驼命名法类似。只不过骆驼命名法是首字母帕斯卡命名法与骆驼命名法类似。只不过骆驼命名法是首字母小写，而帕斯卡命名法是首字母大写，其实两者的本质还是一小写，而帕斯卡命名法是首字母大写，其实两者的本质还是一样的。例如，可以这样命名：样的。例如，可以这样命名：BookInfo（）、（）、string BookName。二者都是采用了帕斯卡命名法。二者都是采用了帕斯卡命名法。在在C#语言中，大多数都是以帕斯卡命名法和骆驼命名法为主，语言中，大多数
17、都是以帕斯卡命名法和骆驼命名法为主，而在而在C+中，以匈牙利命名法最为常见。对于局部变量和方法中，以匈牙利命名法最为常见。对于局部变量和方法的参数大都使用骆驼命名法。的参数大都使用骆驼命名法。注意：以前，大多数程序员喜欢把数据类型作为变量名的前缀注意：以前，大多数程序员喜欢把数据类型作为变量名的前缀而而m_作为成员变量的前缀。例如：作为成员变量的前缀。例如：string m_sName、int nAge。然而，这种方式在。然而，这种方式在.NET编码规范中是不推荐的。编码规范中是不推荐的。本讲稿第十四页，共十五页天道酬勤天道酬勤,有耕耘就会有收获有耕耘就会有收获祝读者们学习愉快祝读者们学习愉快本讲稿第十五页，共十五页