Java开发规范_new详解.doc

SOAR项目Java开发规范 1. 引言 2 2.文件 2 3.命名规则 3 3.1基本的规则 3 3.2常量命名 3 3.3变量命名 4 3.4方法命名 5 3.5类和接口的命名 5 3.6包的命名 6 4.注释规范 6 4.1 基本规则 6 4.2 Java中有三种注释方式说明 6 4.2.1文档注释 /** */ 6 4.2.2行注释 // 7 4.2.3块注释： /* */ 7 4.3类/接口注释 8 4.4 变量注释 9 4.5 方法注释 9 4.6 修改记录 10 5.编码规范 11 5.1基本原则 11 5.2类编写规范 14 5.3变量 15 5.4方法 16 5.5 语言使用及书写规范 16 1. 引言 软件开发涉及到各方面人员的交互、协作，为了有效地进行项目开发的沟通，完善代码的维护和交付，有必要在一个小组中采用统一的软件开发标准。一般来说，制定这样的标准有下列好处： 方便软件维护。据统计，80％的软件开发费用在维护，规范化的代码才方便维护，降低维护成本。 在软件的整个生命期内，期望一个编码人员从开始到该软件报废一致维护其代码是不现实的，必然需要不断地交付、协同 好的编码规范能够大大增强代码的可读性，便于开发人员快速的理解新代码。 任何产品都需要好的包装。我们可以把代码本身看作是一种产品，那么按照规范编程也是对这个“产品”的包装 规范化的代码也是软件质量的保证手段之一，也是软件过程能够流畅的基础。 我们每个人必须牢牢树立这样的观念：你今天所编写的代码，会一直使用很多年，并且很有可能被其他人维护和改进。所以，我们必须努力写出“干净”和易读的代码。 本文档适用于软件开发过程中开发人员，主要包括编码人员、测试人员，开发人员，规范必须严格遵守，否则程序被视为不合格程序。 注：本规范中标红的内容为强制性遵循内容，开发人员必须遵守。蓝色为强烈建议性内容，最好遵守，这样可以避免程序出现一些莫名奇妙的问题。其他内容为一般性建议。 2.文件 属性文件后缀为properties,并且符合java中i18n的规范； 对于各产品模块自己的配置文件必须放置在自己模块的conf目录下； 文件的命名需要有一定的意义，尽量简短，名称符合操作系统的要求且必须为英文或汉语拼音组成，文件名称不能存在空格，对于普通的文件单词与单词之间采用下滑线进行。 3.命名规则 3.1基本的规则 字符集在26个英文字母、0到9的阿拉伯数字和下划线之中。Java中类、字段、方法、变量、常量尽量用字母表达，没有特别的理由不能用任何的其他字符 命名需要有一定的意义，推荐采用问题域中的术语命名，使命名在一定程度上是自描述的 命名尽量的短，如果命名太长，可以采用别名的方式，或者缩写来简化命名。缩写一定要有的意义，而且需要在整个项目中维护这些缩写的意义 名称缩写的规则（对于类名、字段名、变量名称、模块名称等适用） 1）删除所有的原音字母，压缩重复字母。如button,缩写为btn， 2）如发生命名冲突，则在某一缩写中保留原音。如batton,为了不与button冲突，缩写为batn 不要用前导下划线，也不要在命名的末尾用下划线 3.2常量命名 所有的字符都必须大写。采用有意义的单词组合表达，单词与单词之间以“_”下划线隔开。 命名尽量简短，不要超过16个字符 程序开发中最好不要直接对literal进行工作，最好引入常量方式应用；只有在特别的情况下才能使用， 如在for循环中初始化变量时可直接用-1,0,1这些常量。 例： public final int MAX_SIZE = 120; public final int MAX_WIDTH = 100; public final String PROPERTY_NAME= menu ; 3.3变量命名 变量的命名包括实例变量，静态变量，函数参数的命名。 避免在命名中采用数字，除非命名意义明确，程序更加清晰，对实例变量的命名中不应该有数字 变量名称是名词意义 采用有符合问题域意义的单词或单词组合。第一个单词全部小写，后续的每个单词采用首字母大写，其余小写(特殊单词除外，如URL) 命名尽量简短，不要超过16个字符 除了生命周期很短的临时变量外，避免采用单字符作为变量名，实例变量的命名不要用单字符。常用的单字符变量如整型用 i、j、 k、 m、 n字符型用c、d、 e，坐标用x、y、z。 在某些情况下，变量可能需要加上类型前缀，所有的类型前缀必须是小写，他与变量名称的实体部分没有任何间隔，实体部的每个单词都是首字母大写，其余字母小写（特殊单词除外如URL）,类的全局变量强烈建议使用，一般的类型前缀如下： 类型前缀 类型 例子 b Boolean、boolean bsingle f 浮点数 fsize d UFDou