java编码规范
- 格式:doc
- 大小:130.00 KB
- 文档页数:28
java编码规则(最新版)目录1.Java 编码规范简介2.Java 编码的基本规则3.Java 编码的进阶规则4.Java 编码的特殊规则5.Java 编码规范的实际应用正文【Java 编码规范简介】Java 编码规范,是指在编写 Java 程序时遵循的一种编码风格和规则。
遵循 Java 编码规范,可以提高代码的可读性、可维护性和可扩展性,从而提高软件开发的效率和质量。
【Java 编码的基本规则】1.遵循统一的编码风格:整个项目或团队应该遵循统一的编码风格,如缩进、空格、换行等。
2.使用有意义的命名:变量、方法、类等命名应该具有明确、简洁、描述性强的特点。
3.合理使用注释:对于复杂的代码、算法等,应该使用注释进行解释说明,提高代码的可读性。
4.遵循面向对象编程原则:尽量使用封装、继承、多态等面向对象编程原则,提高代码的可扩展性和可维护性。
【Java 编码的进阶规则】1.遵循接口隔离原则:不应该强迫客户端依赖于它们不使用的方法,应该尽量减少非抽象类和接口中的方法数量。
2.遵循依赖倒置原则:高层模块不应该依赖于低层模块,二者都应该依赖于抽象。
3.遵循单一职责原则:类应该有明确的职责,应该只有一个原因改变。
【Java 编码的特殊规则】1.异常处理:应该正确处理异常,避免出现未处理的异常。
2.集合使用:应该正确使用集合,避免出现空指针、越界等错误。
3.多线程编程:应该正确使用多线程编程,避免出现死锁、资源竞争等问题。
【Java 编码规范的实际应用】遵循 Java 编码规范,不仅可以提高代码的质量,还可以提高团队的开发效率,降低维护成本。
java 编码规则
Java编码规则是指在编写Java程序时需要遵循的一系列规范和约定,旨在提高代码的可读性、可维护性和可扩展性。
下面是一些常见的Java编码规则:
1. 代码缩进:使用四个空格进行缩进,不要使用制表符。
2. 代码行长度:每行代码尽量不超过80个字符,超过时可以换行。
3. 命名规范:使用驼峰命名法,即首字母小写,后面每个单词的首字母大写。
4. 类名:类名使用名词或名词短语,首字母大写。
5. 方法名:方法名使用动词或动词短语,首字母小写。
6. 变量名:变量名使用名词或名词短语,首字母小写。
7. 常量名:常量名应全部大写,并用下划线分隔单词。
8. 注释:为代码添加适当的注释,解释代码的用途、实现细节等。
9. 空格使用:在运算符两侧、逗号后面、冒号后面等地方使用空格,增加代码的可读性。
10.代码格式化:使用合适的缩进、空行、大括号等格式化代码,以增强可读性。
遵循这些Java编码规则可以使你的代码更易于理解和维护。
此外,还可以使用一些静态代码分析工具来自动检查代码是否符合编码规范,如Checkstyle、FindBugs等。
编码规则的遵守不仅仅是个人习惯的问题,也是一个团队合作的重要环节,通过统一的编码规范可以提高代码的一致性,方便开发人员的协作和项目的维护。
Java 程序编码规范(初学者要牢记)所有的程序开发手册都包含了各种规则。
一些习惯自由程序人员可能对这些规则很不适应,但是在多个开发人员共同写作的情况下,这些规则是必需的。
这不仅仅是为了开发效率来考虑,而且也是为了后期维护考虑。
命名规范定义这个规范的目的是让项目中所有的文档都看起来像一个人写的,增加可读性,减少项目组中因为换人而带来的损失。
(这些规范并不是一定要绝对遵守,但是一定要让程序有良好的可读性)Package 的命名Package 的名字应该都是由一个小写单词组成。
Class 的命名Class 的名字必须由大写字母开头而其他字母都小写的单词组成Class 变量的命名变量的名字必须用一个小写字母开头。
后面的单词用大写字母开头。
Static Final 变量的命名Static Final 变量的名字应该都大写,并且指出完整含义。
参数的命名参数的名字必须和变量的命名规范一致。
数组的命名数组应该总是用下面的方式来命名:byte[] buffer;而不是:byte buffer[];方法的参数使用有意义的参数命名,如果可能的话,使用和要赋值的字段一样的名字:SetCounter(int size){this.size = size;}Java 文件样式所有的Java(*.java) 文件都必须遵守如下的样式规则版权信息版权信息必须在java 文件的开头,比如:/*** Copyright ? 2000 Shanghai XXX Co. Ltd.* All right reserved.*/其他不需要出现在javadoc 的信息也可以包含在这里。
Package/Importspackage 行要在import 行之前,import 中标准的包名要在本地的包名之前,而且按照字母顺序排列。
如果import 行中包含了同一个包中的不同子目录,则应该用* 来处理。
package .stats;import java.io.*;import java.util.Observable;import hotlava.util.Application;这里java.io.* 使用来代替InputStream and OutputStream 的。
java编码规则摘要:1.Java 编码规范简介2.Java 命名规范3.Java 代码排版规范4.Java 注释规范5.Java 编码实践建议正文:Java 编码规范简介Java 编码规范是为了提高代码的可读性和可维护性,降低程序出错概率,以及便于团队合作而制定的一系列规则。
遵循这些规范可以使代码更加统一和规范,有助于提高开发效率。
Java 命名规范1.包名:使用小写字母,每个单词的首字母大写,用下划线分隔。
2.类名:使用大写字母,每个单词的首字母大写,用下划线分隔。
3.变量名:使用小写字母,每个单词的首字母小写,用下划线分隔。
4.常量名:使用大写字母,每个单词的首字母大写,用下划线分隔。
5.方法名:使用小写字母,第一个单词的首字母大写,用下划线分隔。
Java 代码排版规范1.每行代码不超过79 个字符。
2.类与方法之间空一行。
3.方法内的逻辑块之间空一行。
4.注释与代码保持一定间距。
5.遵循统一的缩进风格。
Java 注释规范1.单行注释:使用双斜杠(//)或斜杠加星号(/*)开头。
2.多行注释:使用斜杠加星号(/*)开头,星号加斜杠(*/)结尾。
3.注释内容简洁明了,阐述代码的功能、原理、注意事项等。
4.保持注释与代码的同步更新。
Java 编码实践建议1.使用有意义的命名,避免使用模糊或过于简化的命名。
2.遵循编码规范,保持代码的一致性。
3.合理使用注释,提高代码的可读性。
4.保持代码简洁,避免过长的方法或类。
5.使用设计模式,提高代码的可重用性和可扩展性。
6.编写单元测试,保证代码质量。
java 规范Java的编码规范是一种旨在提高代码质量和可维护性的指南。
以下是Java编码规范的一些重要原则和规定。
1. 命名规范:- 类名应使用大写字母开头的驼峰命名规范,如:ClassName。
- 方法名、变量名应使用小写字母开头的驼峰命名规范,如:methodName。
- 常量名应使用全部大写的蛇形命名规范,如:CONSTANT_NAME。
2. 缩进和空格:- 使用四个空格进行缩进,不要使用Tab键。
- 二元操作符前后应添加空格,如:a + b。
- 不要在括号内添加空格,如:(a + b)。
3. 大括号和代码块:- 大括号应与相关的代码放在同一行,如:```if (condition) {// code here} else {// code here}```- 单行的代码块也应使用大括号包裹起来。
4. 注释:- 使用Javadoc格式的注释来描述类、方法等的用途。
- 在代码中添加必要的注释,解释代码的逻辑和实现细节。
5. 异常处理:- 建议使用try-catch语句来处理可能抛出异常的代码块。
- 不要捕获所有异常,只捕获你能够处理的异常。
6. 包的命名:- 包的命名应全部使用小写字母,多个单词之间用点号分隔,如:com.example.packageName。
7. 类的设计:- 类的设计应符合单一职责原则,即每个类只有一个主要职责。
- 类应该是可扩展和可重用的,应遵循开闭原则。
8. 方法的设计:- 方法应该尽量简洁,只做一件事情。
- 方法的命名应能清楚地描述它的功能和返回值类型。
9. 代码的可读性:- 避免使用过长的代码行,一行不应超过80个字符。
- 使用空行来分隔逻辑上不同的代码块。
- 使用合适的缩进和空格来增加代码的可读性。
这些只是Java编码规范的一部分内容,旨在提高代码的可读性、可维护性和一致性。
遵循这些规范可以帮助团队成员更好地理解和修改代码,减少潜在的错误和问题。
Java编码规范Java编码规范是指在Java语言开发过程中对代码格式、命名规范、注释等方面的规范。
它涵盖了许多方面,包括代码格式、命名规范、注释等等,并且会让代码更加易于理解和维护。
下面分步骤来阐述Java 编码规范。
1.代码格式- 代码缩进:使用四个空格。
- 代码行长度:每行不超过80个字符。
- 代码块括号:左大括号放在语句后,右大括号独立一行。
- 空行:在方法或类中的单独任务之间使用空白行来分隔。
- 其他注意事项:避免使用过多的空格,在行末不要有空格,避免使用tab字符。
2.命名规范- 包名:使用小写字母,多个单词使用.分割。
- 类名:使用驼峰命名法,每个单词首字母大写。
- 方法名:使用驼峰命名法,每个单词首字母小写。
- 变量名:使用驼峰命名法,每个单词首字母小写。
- 常量名:所有字母大写,单词之间用_分割。
- 其他注意事项:名称应该避免缩写,可读性要优先。
3.注释- 类、方法和变量都应该进行注释。
- 类和方法的注释应当使用javadoc格式。
- 变量和常量可以使用单行注释或行尾注释。
- 注释要避免使用无意义的话语,应该简明扼要地描述该元素的意义。
Java编码规范对开发人员来说是非常重要的,这能让代码更清晰、可读性更强,并且统一规范有助于团队协作的进行。
了解并遵循Java编码规范,可以帮助开发人员编写出高质量的Java代码,从而提高代码质量,减少bug的出现,提高项目的稳定性。
此外,标准的Java编码规范可以方便代码的查看和维护,便于未来项目的扩展。
因此,遵循Java编码规范是每个Java开发人员的责任和义务。
java编码规则【实用版】目录1.Java 编码规范概述2.Java 编码规则详解2.1 命名规范2.2 注释规范2.3 代码格式化2.4 控制结构2.5 数据类型及操作2.6 异常处理2.7 类与对象2.8 接口与继承2.9 泛型2.10 集合框架2.11 多线程正文【提纲】详解1.Java 编码规范概述Java 编码规范,顾名思义,是指在编写 Java 程序时遵循的一系列规则和约定。
这些规范旨在提高代码的可读性、可维护性和可扩展性,帮助开发者编写出高质量的 Java 代码。
Java 编码规范主要涵盖了命名规范、注释规范、代码格式化、控制结构、数据类型及操作、异常处理、类与对象、接口与继承、泛型、集合框架和多线程等方面。
2.Java 编码规则详解2.1 命名规范Java 命名规范主要包括以下几方面:- 类名、接口名和枚举常量名应使用驼峰命名法,即每个单词的首字母大写,除第一个单词外。
- 方法名和变量名应使用驼峰命名法,但第一个单词的首字母小写。
- 常量名应使用大写字母和下划线组合。
- 注释名应以双斜杠(//)开头。
2.2 注释规范注释是程序员对代码的解释和说明,有助于提高代码的可读性。
Java 注释规范要求:- 单行注释以双斜杠(//)开头。
- 多行注释以斜杠星号(/*)开头,以星号斜杠(*/)结尾。
- 注释应简洁明了,避免过多冗余。
2.3 代码格式化代码格式化是指按照一定的风格对代码进行排版,以提高代码的可读性。
Java 代码格式化要求:- 每行代码的长度不超过 80 个字符。
- 语句之间留有空格,以提高可读性。
- 适当的换行和缩进,使代码结构更清晰。
2.4 控制结构Java 控制结构包括条件语句、循环语句和分支语句等。
控制结构应简洁明了,避免过于复杂的逻辑。
2.5 数据类型及操作Java 数据类型包括基本数据类型和引用数据类型。
数据类型操作应遵循以下规范:- 变量应在使用前初始化。
- 避免使用未初始化的变量。
java 编码规范《Java编码规范》1. 代码风格- 代码缩进:使用4个空格进行缩进,不使用制表符。
- 行长限制:每行代码不超过80个字符,超出则进行换行。
- 行尾空格:行尾不留空格。
- 行尾注释:行尾注释与代码之间至少保留2个空格的距离。
- 命名规范:使用驼峰命名法,类名首字母大写,变量和方法名首字母小写。
- 常量命名:常量使用全大写字母,并用下划线分隔单词。
- 空行:类与方法之间保留一个空行,方法内逻辑块之间保留一个空行。
2. 注释规范- 文件注释:每个源文件的头部必须包含文件注释,说明该文件的作者、日期等信息。
- 类注释:每个类的头部必须包含类注释,描述该类的作用、用法等。
- 方法注释:每个方法必须包含方法注释,描述该方法的功能、参数、返回值等。
- 代码注释:在代码中需要加入注释说明的地方,添加合理的注释来增加代码可读性。
3. 包和导入规范- 包名规范:包名全部小写,多个包名之间用英文句点"."分隔,采用反域名形式命名。
- 导入规范:不要使用通配符"*"导入整个包,应明确导入所需的类。
4. 类和接口规范- 类结构顺序:依次按照成员变量、构造方法、普通方法的顺序来编写类的结构。
- 成员变量声明:先声明公有的静态常量,再声明私有的静态变量,接着声明私有的实例变量。
- 构造方法:在类的开头部分声明构造方法,按照方法名和参数顺序进行编写。
- 方法和变量:局部变量应放在使用的最近位置上,避免声明太早或太迟,增加代码的可读性。
5. 异常处理规范- 异常的捕获和处理:在可能发生异常的地方进行捕获和处理,而不是简单地将异常抛出给上层调用者。
- 不要捕获并忽略异常:捕获异常后应该进行适当的处理,而不是简单地将异常信息打印出来或者忽略它们。
6. 标准化代码结构- 采用分层结构:将代码按照功能、模块进行划分,每个模块或类负责一部分功能。
- 逻辑清晰:保持代码逻辑清晰,避免重复、冗余的代码,使用合适的设计模式来优化代码结构。
Java编码规范目录目录 (2)1.编码规范的重要性 (3)2. Java源文件结构 (3)2.1开头注释 (3)2.2 包和引入 (3)3. 缩进排版 (4)3.1 缩进长度 (4)3.2 行长度 (4)3.3 换行 (4)3.4 方法声明缩进 (4)3.5 if语句换行 (5)3.6三元运算表达式缩进 (5)4. 注释 (5)4.1 有效的注释 (5)4.2 注释的方式 (6)4.3 实现注释的使用 (6)5. 空白 (6)5.1 空行 (6)5.2 空格 (7)6. 命名规范 (7)6.1包名 (7)6.2类名和接口名 (8)6.3方法名 (8)6.4存取性方法名 (8)6.5属性名 (8)6.6变量名 (8)6.7一些建议 (9)7. 声明 (9)8. 表达式与语句 (9)9. 类和接口 (9)10.编程习惯 (10)1.编码规范的重要性*编码规范可以改善软件的可读性,可以让程序员尽快理解新代码。
*几乎没有任何一个软件,在其整个生命同期中,均由最初的开发人员来维护。
*一个合格的软件,生命周期中80%的花费在于维护。
2. Java源文件结构2.1开头注释所有的源文件都应该在开头有一个C语言风格的注释,其中列出类名、版本信息,创建日期和版权声明:/ **类名**版本信息**创建日期**版权声明* /2.2 包和引入先写包语句,再写引入语句。
package行和import行之间留一行空行。
引入的标准包名要在本地包名之前,并且包名按照字母顺序排列。
如果import 行中包含了同一个包中的类超过5个,则用* 来处理。
import的标准包和本地包之间留一行空行。
示例:package mon;import java.io.*;import java.sql.DatabaseMetaData;import java.sql.ResultSet;import com.xinma.plan.BaseDao;import com.xinma.plan.dao.SysEquipmentDao;3. 缩进排版3.1 缩进长度缩进一般采用4个空格。
java 常用编码格式
摘要:
1.Java编码格式的介绍
2.UTF-8编码格式的特点和应用
3.UTF-16编码格式的特点和应用
4.UTF-16BE编码格式的特点和应用
5.UTF-16LE编码格式的特点和应用
6.Java编码格式在日常开发中的重要性
正文:
Java是一种广泛使用的编程语言,为了确保程序在不同平台和环境下都能正常运行,Java采用了一种通用的编码格式。
在Java中,常用的编码格式主要有UTF-8、UTF-16、UTF-16BE和UTF-16LE。
UTF-8是一种广泛使用的编码格式,它具有以下特点:
- 采用8位字节表示一个字符,可以表示Unicode字符集中的所有字符- 兼容ASCII编码,即ASCII字符在UTF-8中保持不变
- 支持多个字符在一个字节中,通过使用多字节序列来表示
UTF-16是一种16位编码格式,它具有以下特点:
- 采用16位字节表示一个字符,可以表示Unicode字符集中的所有字符- 不兼容ASCII编码,需要进行转换
- 支持多个字符在一个字节中,通过使用多字节序列来表示
UTF-16BE和UTF-16LE是UTF-16的两种字节顺序表示方式,它们具有
以下特点:
- UTF-16BE(Big Endian):高位字节在前面,低位字节在后面
- UTF-16LE(Little Endian):低位字节在前面,高位字节在后面
在日常Java开发中,正确选择和使用编码格式至关重要。
例如,在处理国际化字符串、文件读写和网络传输等场景时,需要确保数据的正确编码和解码。
选择合适的编码格式可以避免字符丢失、乱码等问题,从而提高程序的稳定性和可维护性。
Java语言编码规范目录一、规范简介 (1)1目的 (1)2范围 (1)3参考文档 (1)4说明 (1)二、 JAVA编码规范 (1)2缩进排版(I NDENTATION) (2)2.1 行长度(Line Length) (2)3注释(C OMMENTS) (2)4声明(D ECLARATIONS) (3)4.1 每行声明变量的数量(Number Per Line) (3)4.2 初始化(Initialization) (3)5空白(W HITE S PACE) (3)5.1 空行(Blank Lines) (3)5.2 空格(Blank Spaces) (4)6命名规范(N AMING C ONVENTIONS) (4)7性能考虑 (5)7.1 使用 StringBuffer 对象 (5)7.2 可移植性 (5)7.3 换行 (5)7.4 PrintStream (6)三、JSP编码规范 (6)四、SERVLET编码规范 (7)五、JSP和SERVLET编程注意事项 (7)六、代码范例(CODE EXAMPLES) (7)一、规范简介1 目的制订本规范的目的是为培养规范设计和编程,养成良好的习惯,增强JAVA类软件产品的稳定、健壮、可靠性;同时也为提高软件的可读性,可以让程序员尽快而彻底地理解新的代码,使产品可维护性提高而制定的强制性规范,同时也是代码复审的依据。
2 范围本规范适用于公司JAVA类代码(包括JSP)的代码编写标准。
适用于代码编写阶段和代码维护阶段。
3 参考文档《SUN JAVA代码编写规范》。
4 说明本文档包括java编码规范,jsp编码规范,servlet编码规范。
struts代码规范请参阅《struts编码规范.doc》。
二、java编码规范1.1.1 开头注释(Beginning Comments)所有的源文件都应该在开头有一个Java语言风格的注释,其中列出标题、描述、日期和版权声明:/*** <p>Title: 标题</p>* <p>Description: 描述</p>* <p>Copyright: Copyright (c) 2007</p>* <p>Company:华胜天成</p>* @author: 张三* @version 1.0*/1.1.2 包和引入语句(Package and Import Statements)在多数Java源文件中,第一个非注释行是包语句。
JAVA最全的编码规范(1) 类名首字母应该大写。
字段、方法以及对象(句柄)的首字母应小写。
对于所有标识符,其中包含的所有单词都应紧靠在一起,而且大写中间单词的首字母。
例如:ThisIsAClassNamethisIsMethodOrFieldName若在定义中出现了常数初始化字符,则大写static final基本类型标识符中的所有字母。
这样便可标志出它们属于编译期的常数。
Java包(Package)属于一种特殊情况:它们全都是小写字母,即便中间的单词亦是如此。
对于域名扩展名称,如com,org,net或者edu等,全部都应小写(这也是Java 1.1和Java 1.2的区别之一)。
(2) 为了常规用途而创建一个类时,请采取"经典形式",并包含对下述元素的定义:equals()hashCode()toString()clone()(implement Cloneable)implement Serializable(3) 对于自己创建的每一个类,都考虑置入一个main(),其中包含了用于测试那个类的代码。
为使用一个项目中的类,我们没必要删除测试代码。
若进行了任何形式的改动,可方便地返回测试。
这些代码也可作为如何使用类的一个示例使用。
(4) 应将方法设计成简要的、功能性单元,用它描述和实现一个不连续的类接口部分。
理想情况下,方法应简明扼要。
若长度很大,可考虑通过某种方式将其分割成较短的几个方法。
这样做也便于类内代码的重复使用(有些时候,方法必须非常大,但它们仍应只做同样的一件事情)。
(5) 设计一个类时,请设身处地为客户程序员考虑一下(类的使用方法应该是非常明确的)。
然后,再设身处地为管理代码的人考虑一下(预计有可能进行哪些形式的修改,想想用什么方法可把它们变得更简单)。
(6) 使类尽可能短小精悍,而且只解决一个特定的问题。
下面是对类设计的一些建议:一个复杂的开关语句:考虑采用"多形"机制数量众多的方法涉及到类型差别极大的操作:考虑用几个类来分别实现许多成员变量在特征上有很大的差别:考虑使用几个类(7) 让一切东西都尽可能地"私有"--private。
Java编码规则是指在编写Java代码时应该遵循的一些规范和约定。
这些规则可以帮助开发者提高代码的可读性、可维护性和可扩展性。
以下是一些常见的Java编码规则:
1. 命名规范:类名使用大写字母开头的驼峰式命名法,方法名和变量名使用小写字母开头的驼峰式命名法。
2. 缩进规范:每个缩进级别使用4个空格,而不是制表符,这样可以避免在不同的编辑器中出现不同的缩进距离。
3. 注释规范:每个类和方法都应该有文档注释,说明它们的作用、参数、返回值和异常等信息。
同时,对于复杂的代码块也应该添加注释。
4. 包命名规范:包名应该全部使用小写字母,并且应该基于域名反转命名。
例如,com.example.app。
5. 文件命名规范:类文件应该与类名相同,并使用驼峰式命名法。
例如,MyClass.java。
6. 代码风格规范:代码应该按照一定的风格排列,例如在每个方法之间应该有空行,在每个语句结束时应该使用分号,在括号周围不应该有空格等。
7. 异常处理规范:对于可能抛出异常的代码块,应该使用try-catch语句或者声明抛出异常。
同时,应该在捕获异常时至少打印异常信息。
8. 安全性规范:应该避免使用不安全的函数,例如eval()和exec()
等,应该使用安全的函数或者自己实现安全策略。
9. 性能规范:应该尽可能地优化代码,例如避免使用不必要的对象、减少方法调用次数等。
以上是一些常见的Java编码规则,当然还有很多其他的规则可以根据需要进行补充和完善。
java编码规范Java编码规范是为了提高代码的可读性、可维护性和可重用性而制定的规范。
本文将向您介绍一些常见的Java编码规范,以帮助您编写高质量的Java代码。
1. 命名规范- 类名使用大写开头的驼峰命名法,例如`MyClass`。
- 方法名使用小写开头的驼峰命名法,例如`myMethod`。
- 变量名使用小写的驼峰命名法,例如`myVariable`。
- 常量名使用全大写并用下划线分隔单词,例如`MAX_SIZE`。
- 包名使用全小写并用点分隔单词,例如`com.example.myapp`。
2. 注释规范- 类、方法和变量前应添加注释,说明其作用和用法。
- 可以使用`//`进行行注释,例如:`// This is a comment`。
- 可以使用`/* */`进行块注释,例如:```/** This is a block comment* It can span multiple lines*/```- 每个文件应包含版权信息和作者信息的注释。
3. 缩进规范- 使用4个空格进行缩进,不使用制表符。
- 每个代码块应该有一个缩进级别。
4. 括号规范- 左括号应该在语句或声明的同一行,并在后面加上一个空格。
- 右括号应该独占一行。
```if (condition) {// code here}```5. 空格规范- 在二元运算符之间、逗号之后和分号之后应添加一个空格。
- 在关键字和左括号之间、左括号和参数之间、方法名和左括号之间不应有空格。
6. 异常处理规范- 在可能引发异常的代码周围使用`try-catch`块来处理异常。
- 在`catch`块中处理异常,不要简单地打印异常信息。
- 在方法声明中使用`throws`关键字指定可能抛出的异常。
7. 包规范- 包名应该反映代码的层次结构和功能。
- 不要使用Java的保留关键字作为包名。
8. 导入规范- 不要使用通配符导入,应该明确导入需要使用的类。
文档版本:1.0编码规范1、排版规范1- 1:程序块要采用缩进风格编写,缩进的空格数为4个。
说明:对于由开发工具自动生成的代码可以有不一致。
1- 2:相对独立的程序块之间、变量说明之后必须加空行。
示例:如下例子不符合规范。
if (!valid_ni(ni)){... // program code}repssn_ind = ssn_data[index].repssn_index;repssn_ni = ssn_data[index].ni;应该改进为如下书写方法:if (!valid_ni(ni)){... // program code}repssn_ind = ssn_data[index].repssn_index;repssn_ni = ssn_data[index].ni;1- 3:较长的语句(>80字符)要分成多行书写,长表达式要在低优先级操作符处划分新行,操作符放在新行之首,划分出的新行要进行适当的缩进,使排版整齐,语句可读。
1- 4:循环、判断等语句中若有较长的表达式或语句,则要进行适应的划分,长表达式要在低优先级操作符处划分新行,操作符放在新行之首。
示例:if ((taskno < max_act_task_number)&& (n7stat_stat_item_valid (stat_item))){... // program code}1- 5:若方法或过程中的参数较长,则要进行适当的划分。
1- 6:不允许把多个短语句写在一行中,即一行只写一条语句。
示例:如下例子不符合规范。
rect.length = 0; rect.width = 0;应如下书写rect.length = 0;rect.width = 0;1- 7:if、for、do、while、case、switch、default等语句自占一行,且if、for、do、while等语句的执行语句部分无论多少都要加括号{}。
Java语言编码规范Prepared by拟制Date日期yyyy-mm-ddReviewed by 评审人Date日期yyyy-mm-ddApproved by批准Date日期yyyy-mm-ddRevision Record 修订记录Table of Contents 目录1.范围 (4)2.规范性引用文件 (4)3.术语和定义 (4)4.排版规范 (5)4.1.规则 (5)4.2.建议 (7)5.注释规范 (8)5.1.规则 (8)5.2.建议 (13)6.命名规范 (16)6.1.规则 (16)6.2.建议 (17)7.编码规范 (19)7.1.规则 (19)7.2.建议 (22)8.JTEST规范 (24)8.1.规则 (24)8.2.建议 (25)1.范围本规范规定了使用Java语言编程时排版、注释、命名、编码和JTEST的规则和建议。
本规范适用于使用Java语言编程的产品和项目。
2.规范性引用文件下列文件中的条款通过本规范的引用而成为本规范的条款。
凡是注日期的引用文件,其随后所有的修改单(不包括勘误的内容)或修订版均不适用于本规范,然而,鼓励根据本规范达成协议的各方研究是否可使用这些文件的最新版本。
凡是不注日期的引用文件,其最新版本适用于本规范。
3.术语和定义规则:编程时强制必须遵守的原则。
建议:编程时必须加以考虑的原则。
格式:对此规范格式的说明。
说明:对此规范或建议进行必要的解释。
示例:对此规范或建议从正、反两个方面给出例子。
4.排版规范4.1.规则4.1.1.*程序块要采用缩进风格编写,缩进的空格数为4个。
说明:对于由开发工具自动生成的代码可以有不一致。
4.1.2.*分界符(如大括号‘{’和‘}’)应各独占一行并且位于同一列,同时与引用它们的语句左对齐。
在函数体的开始、类和接口的定义、以及if、for、do、while、switch、case语句中的程序都要采用如上的缩进方式。
示例:如下例子不符合规范。
for (...) {... // program code}if (...){... // program code}void example_fun( void ){... // program code}应如下书写:for (...){... // program code}if (...){... // program code}void example_fun( void ){... // program code}4.1.3.*较长的语句、表达式或参数(>80字符)要分成多行书写,长表达式要在低优先级操作符处划分新行,操作符放在新行之首,划分出的新行要进行适当的缩进,使排版整齐,语句可读。
示例:if (filename != null&& new File(logPath + filename).length() < LogConfig.getFileSize()){... // program code}public static LogIterator read(String logType, Date startTime, Date endTime, int logLevel, String userName, int bufferNum)4.1.4.*不允许把多个短语句写在一行中,即一行只写一条语句示例:如下例子不符合规范。
LogFilename now = null; LogFilename that = null;应如下书写:LogFilename now = null;LogFilename that = null;4.1.5.*if, for, do, while, case, switch, default 等语句自占一行,且if, for, do, while等语句的执行语句无论多少都要加括号{}。
示例:如下例子不符合规范。
if(writeToFile) writeFileThread.interrupt();应如下书写:if(writeToFile){writeFileThread.interrupt();}4.1.6.*相对独立的程序块之间、变量说明之后必须加空行。
示例:如下例子不符合规范。
if(log.getLevel() < LogConfig.getRecordLevel()){return;}LogWriter writer;应如下书写:if(log.getLevel() < LogConfig.getRecordLevel()){return;}LogWriter writer;int index;4.1.7.*对齐只使用空格键,不使用TAB键。
说明:以免用不同的编辑器阅读程序时,因TAB键所设置的空格数目不同而造成程序布局不整齐。
JBuilder、UltraEdit等编辑环境,支持行首TAB替换成空格,应将该选项打开。
4.1.8.*在两个以上的关键字、变量、常量进行对等操作时,它们之间的操作符之前、之后或者前后要加空格;进行非对等操作时,如果是关系密切的立即操作符(如.),后不应加空格。
说明:采用这种松散方式编写代码的目的是使代码更加清晰。
由于留空格所产生的清晰性是相对的,所以,在已经非常清晰的语句中没有必要再留空格,如果语句已足够清晰则括号内侧(即左括号后面和右括号前面)不需要加空格,多重括号间不必加空格,因为在Java语言中括号已经是最清晰的标志了。
在长语句中,如果需要加的空格非常多,那么应该保持整体清晰,而在局部不加空格。
给操作符留空格时不要连续留两个以上空格。
示例:(1)逗号、分号只在后面加空格。
int a, b, c;(2)比较操作符, 赋值操作符"="、 "+=",算术操作符"+"、"%",逻辑操作符"&&"、"&",位域操作符"<<"、"^"等双目操作符的前后加空格。
if (current_time >= MAX_TIME_VALUE)a =b + c;a *= 2;a =b ^ 2;(3)"!"、"~"、"++"、"--"、"&"(地址运算符)等单目操作符前后不加空格。
flag = !isEmpty; // 非操作"!"与内容之间i++; // "++","--"与内容之间(4)"."前后不加空格。
p.id = pid; // "."前后不加空格(5)if、for、while、switch等与后面的括号间应加空格,使if等关键字更为突出、明显。
if (a >= b && c > d)4.2.建议类属性和类方法不要交叉放置,不同存取范围的属性或者方法也尽量不要交叉放置。
格式:类定义{类的公有属性定义类的保护属性定义类的私有属性定义类的公有方法定义类的保护方法定义类的私有方法定义}5.注释规范5.1.规则5.1.1.一般情况下,源程序有效注释量必须在30%以上。
说明:注释的原则是有助于对程序的阅读理解,在该加的地方都加了,注释不宜太多也不能太少,注释语言必须准确、易懂、简洁。
可以用注释统计工具来统计。
5.1.2.包的注释:包的注释写入一名为 package.html 的HTML格式说明文件放入当前路径。
说明:方便JavaDoc收集示例:com/huawei/msg/relay/comm/package.html5.1.3.包的注释内容:简述本包的作用、详细描述本包的内容、产品模块名称和版本、公司版权。
说明:在详细描述中应该说明这个包的作用以及在整个项目中的位置。
格式:<html><body><p>一句话简述。
<p>详细描述。
<p>产品模块名称和版本<br>公司版权信息</body></html>示例:<html><body><P>为 Relay 提供通信类,上层业务使用本包的通信类与SP进行通信。
<p>详细描述。
<p>MMSC V100R002 Relay<br>(C) 版权所有 2002-2007 文思创新技术有限公司</body></html>5.1.4.文件注释:文件注释写入文件头部,包名之前的位置。
说明:注意以 /* 开始避免被 JavaDoc 收集示例:/** 注释内容*/package m;5.1.5.文件注释内容:版权说明、描述信息、生成日期、修改历史。
说明:文件名可选。
格式:/** 文件名:[文件名]* 版权:〈版权〉* 描述:〈描述〉* 修改人:〈修改人〉* 修改时间:YYYY-MM-DD* 修改单号:〈修改单号〉* 修改内容:〈修改内容〉*/说明:每次修改后在文件头部写明修改信息,CheckIn的时候可以直接把蓝色字体信息粘贴到VSS的注释上。
在代码受控之前可以免去。
示例:/** 文件名:LogManager.java* 版权:Copyright 2002-2007 Huawei Tech. Co. Ltd. All Rights Reserved.* 描述: MMSC V100R002 Relay 通用日志系统* 修改人:张三* 修改时间:2001-02-16* 修改内容:新增* 修改人:李四* 修改时间:2001-02-26* 修改单号:WSS368* 修改内容:。
* 修改人:王五* 修改时间:2001-03-25* 修改单号:WSS498* 修改内容:。
*/5.1.6.类和接口的注释:该注释放在 package 关键字之后,class 或者 interface 关键字之前。
说明:方便JavaDoc收集。
示例:package m;/*** 注释内容*/public class CommManager5.1.7.类和接口的注释内容:类的注释主要是一句话功能简述、功能详细描述。
说明:可根据需要列出:版本号、生成日期、作者、内容、功能、与其它类的关系等。
如果一个类存在Bug,请如实说明这些Bug。
格式:/*** 〈一句话功能简述〉* 〈功能详细描述〉* @author [作者]* @version [版本号, YYYY-MM-DD]* @see [相关类/方法]* @since [产品/模块版本]* @deprecated*/说明:描述部分说明该类或者接口的功能、作用、使用方法和注意事项,每次修改后增加作者和更新版本号和日期,@since 表示从那个版本开始就有这个类或者接口,@deprecated 表示不建议使用该类或者接口。