软件系统开发中统一项目组各个成员的代码风格的重要性和必要性.pdfVIP

软件系统开发中统一项目组 各个成员的代码风格的重要性和必要性 1、杂乱无序的代码所带来的结果 （1）阅读代码杂乱冗余的程序时经常会心生厌恶，大家也经常出 现过因所阅读的程序代码晦涩难懂而抓狂，也经常在跟踪调试 自己的程序代码时为自己的代码中的“低级逻辑错误”和“括 号不匹配”而愤慨过！ （2）而造成这些错误的主要原因其实都是由于自己的程序代码或 者所阅读的程序代码没有良好的结构而造成的恶果。 2、如何培养书写良好代码风格的意识 平时多阅读JDK中的各个Demo示例的源代码，也就基本上能 够把握住良好风格的程序结构。 3、良好的风格代码主要体现在哪些方面 我们经常阅读“名家的作品”不仅是希望获得解决问题 的技巧，也还可以培养编写出规范化的代码结构的基本意识。 下面推荐一些基本的规则和要求给大家参考： （1）层次缩进代码 当源程序代码行数越来越多时，程序行在竖直方向上将 会“参差不齐”，此时可以在Eclipse IDE中采用“Ctrl+I” 自动对齐和层次缩进代码。 （2）自动格式化程序代码 当自己感觉程序代码比较“混乱”时，在Eclipse IDE中 可以采用Ctrl+Shilft+F重新格式化代码，“清洁”自己“乱 疯疯”的程序。 （3）尽可能去除没有用到的类和接口的import引用语句 在Eclipse IDE中可以采用Ctrl+Shilft+O重新导入在本程 序中所需要的各个import引用语句而达到取消无用的import引 用语句的结果。 （4）对相对独立的程序代码块应该要 合理地运用空行隔开 有利于阅读和理解，不需要节省 屏幕空间。 （5）对重复的程序代码段要应用重构（Refactor）的技术，封装 到某个private形式的方法中 在Eclipse工具中选 中代码段，然后选择 “Refactor”菜单内的 “Extract Method”子 菜单项目， Eclipse工具会弹出方法定义的对话框，然后定义方法的 名称和访问控制选项、异常抛出等定义。 （6）减少if、for等语句块内的代码数量，比较多的代码同样也 应该要封装到某个private形式的方法中，从而减少代码中的 “括号”的不匹配性错误 （7）if、for等语句块内 的代码要放入“{ }”内 如下示例代码很容易 出现错误，因此应该要 保证if、for等语句块内 的代码要放入“{ }”内： （8）类中的成员属性统一在程序类代码的前端按用途分组排列 定义、方法内的局部变量集中在方法的前端定义 1）“数据”和“代码”分开编写，而不要“数据”和 “代码”混合编写。 2）早期的Pascal语言强烈地推荐采用“数据”和“代码” 分离编写的代码风格，Java等语言则对此风格相对“宽容”。 （9）尽可能不要采用内部（内嵌）类特别是匿名内部类 因为内部类不仅会降 低程序代码的可读性，而 且也会导致源程序在编译 后将会产生出许多“稀稀 落落”的*.class小文件， 影响JVM对类文件的加载 性能。 （10）规范类和接口等程序的注释信息 1）可以参考JDK中所包含的Demo示例中的源程序的注释信 息示例，熟悉和了解如何正确地为类和接口添加注释信息。 2）对类和接口的总体注释的信息一般要包括文件名（对 此，我个人认为没有必要，因为类名也就是文件名称）、日 期、作者、版本号等信息，并保持整个项目采用统一的注释 模板。 但也要注意代码中的过多的注释将意味着代码可能不良 好，如果在代码中存在有长长的注释，很多场合下将意味着 代码很糟糕。因此，需要先重构代码，再写上必要的注释。 （11）充分应用注释信息提高源代码的可理解性 一般应该要对系统中的功能代码段、业务逻辑规则、不 容易理解类变量的含义、核心业务方法和Util工具方法等进 行详细的注释，使得上层的应用人员能够更方便和清晰地应 用自己的代码，减少代码中的“歧义”。 （12）随时关注Eclipse工具对源代码所提出的各个“警告”信 息，并改进相关的代码 1）“警告”并不是“错误”，类似于“道德”并不等同 于“法律”。 2）尽管不是必须要修改的，但尽可能关注和修正这些 “警告”信息所涉