最新版软件工程建设标准.docxVIP

软件工程建设标准 软件工程建设标准 Page Page PAGE # of 24 目录 TOC \o 1-5 \h \z 前言 5 1.1目的 5 1.2概述 5 \o Current Document 命名规范(Naming Conventions) 5 2.1包命名 6 2.2类命名 6 2.3接口命名 6 2.4方法命名 7 2.5类成员参数 7 2.6局部变量 7 2.7常量 8 2.8集合 8 2.9廈法数字 8 2.10其他 9 2.11项目分层 9 代码排版规范 10 3.1空行 10 3.2空格 11 大括号(Braces) 11 换行(New Lines) 12 长度(Length) 12 声明 12 4?1类、接口 12 Page 4 of 25 Page 5 of 25 Page Page PAGE # of 25 1.刖言 1.1目的 本规范的目的是使本组织能以标准的、规范的方式设计和编码。通过建立编码规范， 以使每个开发人员养成良好的编码风格和习惯；并以此形成开发小组编码约定，提高程序 的可靠性、可读性、可修改性、可维护性和一致性等，增进团队间的交流，并保证软件产 品的质量。 1.2概述 对于代码，首要要求是它必须正确，能够按照设计预定功能去运行；第二是要求代码 必须清晰易懂，使自己和其他的程序员能够很容易地理解代码所执行的功能等。然而，在 实际开发中，每个程序员所写的代码却经常自成一套，很少统一，导致理解困难，影响团 队的开发效率及系统的质量等。因此，依照国标并结合开发规范，严格执行的开发规范是 非常必须的，特别是对软件公司的开发团队而言。 最根本的原则： 代码是软件工程里面的产品设计、系统架构设计等工作的最后承载体，代码的质量决 定了一切工作的成败。我们在写代码的时候，从头至尾都应该考虑性能问题，对于代码， 要具备“精益求精”的工匠精神，要注意代码的效率。适当的规范和标准绝不是消灭代码 内容的创造性、优雅性，而是限制过度个性化，以一种普遍认可的方式一起做事，降低故 障率，提升协作效率。 2.命名规范(Naming Conventions) 命名规范使程序更易读，从而更易于理解。它们也可以提供一些有关标识符功能的 信息，以助于理解代码，例如，不论它是一个常量，包，还是类。大家遵守一定的规范， 相互看其他人的代码也会更加方便。 ?使用可以准确说明变量/字段/类/接口/包等的完整的英文描述符。例如，采用类 似 firstName，listAIIUsers 或 CorporateCustomer 这样的名字，尽量不使用 汉语拼音及不相关单词命名，严禁使用汉语拼音首字母组合命名，虽然 Java支 持Unicode命名，但本规范规定对包、类、接口、方法、变量、字段等不得使用 汉字等进行命名。 ?采用该领域的术语。如果用户称他们的“客户” (clients) 为“顾客” (customers)， 那么就采用术语Customer来命名这个类，而不用Client 。 ?采用大小写混合，提高名字的可读性。一般应该采用小写字母，但是类和接口的 名字的首字母，以及任何中间单词的首字母应该大写。包名全部小写。 ?避免使用长名字(最好不超过25个字母)。 ?避免使用相似或者仅在大小写上有区别的名字。 ?避免使用数字，但可用2代替to，用4代替for等，如：go2Jsp。 2.1包命名 包名一般以项目或模块名命名，少用缩写和长名，一律小写，正则表达式为： A［a-z］+(\.［a-zA-Z」［a-zA-Z0-9」*)*$ 。 包名按如下规则组成：［基本包］.［项目名］.［模块名］.［子模块名］.. 例如：0A项目的包命名前三级为：com.well.oa 。 不得将类直接定义在基本包下，所有项目中的类、接口等都当定义在各自的项目和模块 包中。 2.2类命名 类名采用大小写混合的方式，每个单词的首字母大写。尽量使你的类名简洁而富于 描述。使用完整单词，避免缩写词(除非该缩写词被更广泛使用，像 URL HTML) —般采 用名词。 2.3接口命名 大小写规则与类名相似。接口可带I前缀或able、ible、er等后缀。 Page Page PAGE # of 25 2.4方法命名 方法名是一个动名结构，采用大小写混合的方式，第一个单词的首字母小写，其后 单词的首字母大写。正则表达式为： A[a-z][a-zA-Z0-9]*$ 类中常用方法的命名： 类的获取方法(一般具有返回值)一般要求在被访问的字段名前加上 get，如 getFirstName() ，getLastName()。 类的设置方法(一般返回类型为 void ):被访问字段名的前面加上前缀 set ，如 setFirstName(),s