欢迎来到天天文库
浏览记录
ID:41111463
大小:249.96 KB
页数:32页
时间:2019-08-16
《《JAVA编码规范》PPT课件》由会员上传分享,免费在线阅读,更多相关内容在教育资源-天天文库。
1、JAVA编码规范编码规范的重要性一个软件的生命周期中,80%的花费在于维护。几乎没有任何一个软件,在其整个生命同期中,均由最初的开发人员来维护。编码规范可以改善软件的可读性,可以让程序员尽快而彻底地理解新代码。包和引入在多数Java源文件中,第一个非注释行是包语句行。在它之后可以跟引入语句。例如:packagejava.awt;importjava.awt.peer.CanvasPeer排版缩进4个空格常被作为缩进排版的一个单位(一个制表符)。行长度尽量避免一行长度超过80个字符。注意:用于文档时应该使用更短的行长,长度一般不超过70个字符。换行当一
2、个表达式无法容纳在一行内时,可以依据如下一般规则断开之:◆在一个逗号后面断开。◆在一个操作符前面断开。◆新的一行应该与上一行同一级别表达式的开头处对齐。◆如果以上规则导致你的代码混乱或者使你的代码都堆挤在右边,那就代之以缩进8个空格。以下是断开方法的一些例子:注释Java程序有两类注释,实现注释(implementationcomments)和文档注释(documentcomments):实现注释使用/*…*/和//界定的注释,用以注释代码或实现细节。文档注释(被称为“doccomments”)是Java独有的,并由/**…*/界定,描述代码的规范。
3、文档注释可以通过javadoc工具转换成HTML文件。实现注释:块注释块注释通常用于提供对文件,方法,数据结构和算法的描述。块注释被置于每个文件的开始处以及每个方法之前。它们也可以被用于其他地方,比如方法的内部。该注视应和其描述的代码有一样的缩进。块注释可以以/*-开头,这样就可以将之识别为一个代码块的开始,而不会重排它。实现注释:单行注释短注释可以显示一行内,并与其后的代码具有一样的缩进层级。如果一个注释不能在一行内写完,就该块注释(参见“块注释”)。单行注释之前应该有一个空行。以下是一个Java代码中单行注释的例子:实现注释:尾端注释极短的注释可
4、以与它们所要描述的代码位于同一行,但是应该有足够的空白来分开代码和注释。若有多个短注释出现于大段代码中,它们应该具有相同的缩进。以下是一个Java代码中尾端注释的例子:实现注释:行末注释注释界定符“//”,可以注释掉整行或者一行中的一部分。它一般不用于连续多行的注释文本;然而,它可以用来注释掉多行的代码段。以下是例子:文档注释文档注释描述Java的类、接口、构造器、方法,以及字段(field)。每个文档注释都会被置于注释界定符/**…*/之中,一个注释对应一个类、接口或成员。该注释应位于声明之前。声明推荐一行一个声明,因为这样以利于写注释。每行声明变
5、量的数量布局只在代码块的开始处声明变量(一个块是指任何被包含在大括号“{”和“}”中间的代码)。不要在首次用于该变量时才声明之,这会把注意力不集中的程序员搞糊涂,同时会妨碍代码在该作用域内的可移植性。该规则的一个例外是for循环的索引变量for(inti=0;I6、应紧跟在“{”之后。◆方法与方法之间以空行分隔。语句简单语句:每行至多包含一条语句。复合语句:复合语句是包含在大括号中的语句序列,形如“{语句}”。返回语句:一个带返回值的return语句不使用小括号“()”,除非它们以某种方式使返回值更显见。if,if-else,ifelse-ifelse语句。if语句问题用“{”和“}”括起来,避免使用如下容易引起错误的格式。for语句(forStatements)。while语句。do-while语句。switch语句。每当一个case顺着往下执行时(因为没有break语句),通常应在break语句的位置添加注7、释。try-catch语句。语句空白空行将逻辑相关的代码段分隔开,以提高可读性。下列情况应总是使用两个空行:◆一个源文件的两个片段(section)之间。◆类声明和接口声明之间。下列情况应该总是使用一个空行:◆两个方法之间。◆方法内的局部变量和方法的第一条语句之间。◆一个方法内的两个逻辑段之间,用以提高可读性。空格注意:空格不应该置于方法名与其左括号之间,这将有助于区分关键字和方法调用。◆空白应该位于参数列表中逗号的后面。◆所有的二元运算符,除了“.”,应该使用空格将之与操作数分开。一元操作符和操作数之间不应该加空格,比如:负号(“-”),自增(“+8、+”)和自减(“--”)。命名规范:包一个唯一包名的前缀总是全部小写的ASCⅡ字母并且是一个顶级域名,通常是
6、应紧跟在“{”之后。◆方法与方法之间以空行分隔。语句简单语句:每行至多包含一条语句。复合语句:复合语句是包含在大括号中的语句序列,形如“{语句}”。返回语句:一个带返回值的return语句不使用小括号“()”,除非它们以某种方式使返回值更显见。if,if-else,ifelse-ifelse语句。if语句问题用“{”和“}”括起来,避免使用如下容易引起错误的格式。for语句(forStatements)。while语句。do-while语句。switch语句。每当一个case顺着往下执行时(因为没有break语句),通常应在break语句的位置添加注
7、释。try-catch语句。语句空白空行将逻辑相关的代码段分隔开,以提高可读性。下列情况应总是使用两个空行:◆一个源文件的两个片段(section)之间。◆类声明和接口声明之间。下列情况应该总是使用一个空行:◆两个方法之间。◆方法内的局部变量和方法的第一条语句之间。◆一个方法内的两个逻辑段之间,用以提高可读性。空格注意:空格不应该置于方法名与其左括号之间,这将有助于区分关键字和方法调用。◆空白应该位于参数列表中逗号的后面。◆所有的二元运算符,除了“.”,应该使用空格将之与操作数分开。一元操作符和操作数之间不应该加空格,比如:负号(“-”),自增(“+
8、+”)和自减(“--”)。命名规范:包一个唯一包名的前缀总是全部小写的ASCⅡ字母并且是一个顶级域名,通常是
此文档下载收益归作者所有