科技创新与应用ｌ ２０１５￣２６ 信息技术 浅谈软件开发过程中的编程规范 王海涛 （黑龙江林业职业技术学院信息工程系，黑龙江牡丹江１５７０００） 摘要：文章探讨了软件开发的编程规范，研究如何建立编程规范，从而增强编程人员的合作，提高项目开发的效率等。 关键词：软件开发；编程；规范 随着信息技术的发展，软件的开发越来越多，如何规范并有效 地编程是软件开发过程中的重要内容，按照编码规范书，统一编程 人员的编程风格，能够提高项目中编程人员的沟通与合作，提高整 个团队的开发效率，提高整个项目的可读性、可维护性、可修改性、 可靠性及一致性。通过编写编码规范书，为项目确立一个统一的编 代码的书写，要添加详细的注释，提高代码在程序员间的理解 和沟通。如果程序不被注释的话，则该代码毫无价值可言。好的注释 能增加代码的清晰度，提高开发的效率。注释要遵照简洁、清楚易于 理解的原则，避免拖沓冗长的描写。注释要给出功能性的说明，给出 初始说明以及结果的描述，还应给出相应的原因等，不应为了注释 码风格，约束每一位开发人员的编码写法，统一编码写法，提高编程 而注释。变量、简短语句的注释在所在行的行尾添加，其他注释在代 的质量，提高编程的可阅读性，尽力杜绝因编码风格引起的安全性 码语句之前添加注释。每一个文件、包的头部要注明相关的信息，比 问题及阅读理解代码困难等隐患。 如该文件的名称、版本、版权、创建和修改等相关信息，相关信息用， １缩进、间隔、对齐 料／注释。在方法前添加 ，注释，注明相关的信息，名称、方法功能 每一行代码不能超过８０个字符（包括之前缩进的ＴＡＢ），如果 说明、参数说明、返回值说明等信息。应对重要的变量添加注释，说 超过８０个字符的话要进行折行处理，同时如果折行的话，要注意如 明其含义等等。复杂的分支、表达式、不易理解的循环等添加相应的 何断行，尽力在代码长度接近８Ｏ字符的位置断行，同时尽力在操作 注释，概况其实现的功能内容等。 符优先级低的部分进行断行且同时折行部分做相应的缩进，这样能 个类的例子（简略）： ｐａｃｋａｇｅ ｄａｏ； 够增加代码的可读性。尽力避免出现很大的类、很大的方法和很大 的功能模块。如果出现较大的类，则应把相应功能代码重构到其他 ｉｍｐｏｒｔ ｊａｖａ．ｕｔｉｌ．Ｌｉｓｔ； ｉｍｐｏｒｔ ｏｒｇ．ｈｉｂｅｒｎａｔｅ．Ｓｅｓｓｉｏｎ； 类中，通过组合灯进行调用。如果出现较大的方法、功能模块的话， ，丰 则应用子方法等进行抽取，这样也有利于理解和代码的复用的优 点，代码应该以清楚明了的逻辑实现复杂的功能。 操作数据库用的基础类 每一个子模块都在父模块缩进一个ＴＡＢ（一个ＴＡＢ四个空 ＠作者张三 格），能够很好地体现逻辑层次，提高代码的可读性。循环、条件等内 ＠创建时间２０１５—０５—１２ 部代码应缩进一个ＴＡＢ。相同层次的代码对齐。左大括号“ｆ”应该紧 ＠修改作者张三 随相关语句之后，而相呼应的右大括号“ｌ”则单独作为一行出现，且 ＠修改时间２０１５—０５—１２ 木， 缩进与相对应的左大括号“ｆ”的缩进相同。ｉｆ－ｅｌｓｅ语句或者ｆｏｒ、ｗｈｉｌｅ 等循环语句必须用左大括号“ｆ”和右大括号“｝”把要执行的内容包含 ｐｕｂｌｉｃ ｃｌａｓｓ ＢａｓｅＤａｏ ｆ ，木 在一起，不论内部的执行是一行代码还是多行代码，不要用缩进的 形式代替左大括号“｛”和右大括号“１＇’的功能，这样容易理解阅读，且 获得总页数。 不易出错。 ＠ｐａｒａｍ ｈｑｌ查询用的ｈｑｌ语句 类、方法、重要的功能模块、较大的功能模块之间应该添加空 ＠ｐａｒａｍ ｐａｇｅＳｉｚｅ每一页的最大显示数据条数 行，同时在操作符的左右两端添加空格，进行连续赋值时每一行的 ＠ｒｅｔｕｒｎ ｔｏｔａＰａｇｅ总页数 ＠ｔｈｒｏｗｓ Ｅｘｃｅｐｔｉｏｎ 相应操作符应对齐，相同类型的变量定义紧挨着，关系紧密的行应 木， 该紧挨着，并把相应的操作符、类型、参数等对齐，以增加其可读性。 ｐｕｂｌｉｃ ｉｎｔ ｇｅｔＣｏｕｎｔＰａｇｅ（Ｓｔｒｉｎｇ ｈｑｌ，ｉｎｔ ｐａｇｅＳｉｚｅ）ｔｈｒｏｗｓ Ｅｘ— ２命名规则 ２．１包、类、方法的命名规范 ｃｅｐｔｉｏｎ ｌ 包、类、方法的命名为英文字符和数字，且首字符必须是英文字 ／／操作数据库用的Ｓｅｓｓｉｏｎ对象 Ｓｅｓｓｉｏｎ ｓｅｓｓｉｏｎ＝ｎｕｌｌ： 符，命名能够准确反映相应的包、类、方法的意义，采用相关领域的 专业术语，不要用Ｕｎｉｃｏｄｅ的命名，不要用汉语拼音等形式命名。包 ／／总页数 ｉｎｔ ｔｏｔａＰａｇｅ＝Ｏ： 名的字母为小写，且包名要有相应的意义，例如：ｃｏｒｎ．ｂｅｉｊｉｎｇ．ｂｅａｎ。类 名的首字母为大写，其他字母为小写，大小写结合，提高可读性，每 ｔｒｙ｛ 个单词的第一个字母大写，其它的为小写，单词能够反应该类、接 ，／总页数 口的含义和功能等，一般采用名词。所有的接口名字之前加上Ｉ前 ｔｏｔａＰａｇｅ＝（ｃｏｕｎｔ％ｐａｇｅＳｉｚｅ＝＝Ｏ）？（ｃｏｕｎｔ／ｐａｇｅＳｉｚｅ）： 缀。抽象类的名字之前Ａｂｓｔｒａｃｔ前缀。例如：ＵｓｅｒＡｃｔｉｏｎ．ｊａｖａ。类的实 （ｃｏｕｎｔ ／ｐａｇｅＳｉｚｅ＋１）： 例则为小写表示，比如Ｕｓｅｒ类的实例命名为ｕｓｅｒ．ｊａｖａ。 ２．２方法的命名 ｝ｃａｔｃｈ（Ｅｘｃｅｐｔｉｏｎ ｅｘ）｛ 方法命名采用完整英语单词，首字母小写，其他单词的第一个 ／／抛出异常 ｔｈｒｏｗ ｎｅｗ ＤＢＥｘｃｅｐｔｉｏｎ（“操作数据库出错！”）； 字母大写，其他字母小写，同时方法的名称的第一个单词往往是一 些动词，代表完成的操作等，例如：ｇｅｔＤＢＣｏｎｎｅｃｔｉｏｎ（）。 ｌ ｒｅｔｕｍ ｔｏｔａＰａｇｅ； ２Ｉ３变量和参数的命名 酋字母小写，其它单词的第一个字母大写，其他部分为小写，例 ｌ 如：ｆｉｒｓｔＮａｍｅ、ｌｉｓｔＡｌｌＣｕｓｔｏｍｅｒｓ、Ｍａｎａｇｅｒ。对于常量要采用完整的英 ｝ 文大写单词，且能正确反映相应的实际意义，比如ｓｔａｔｉｃ Ｓｔｒｉｎｇ ＭＡＮ 编码规范在软件项目开发中占据重要位置，项目开发不是一个 一一＝“男”。 人的项目，软件项自是一个团队开发的项目，合理有效的编码规范 ２．４组件和部件的命名 有利于团队成员间的沟通与合作，如何编写合理有效的编程规范是 组件和部件的命名则应该按照匈牙利命名的法则。匈牙利规则 每一个项目开发中研究和确定的。 参考文献 的基本原则非常简单，名字由两部分构成：类型（Ｔｙｐｅ）和限定词 ｌ】陈蓝．软件世界【Ｊ】＿软件世界，１９９５（２）：５９ （Ｑｕａｌｉｉｆｅｒ）ｒ・１。即命名的原则：变量名＝属性＋类型＋对象描述，其中每 【对象的名称都要求有明确含义，可以取对象名字全称或名字的一 部分。例如：ｂｔｎＬｏｇｉｎ，ｔｘｔＮａｍｅ。 一３注释 一７６一
