首页 电脑 电脑学堂 查看内容

在合适的地方插入空格与空行

2010-2-4 14:02 979 0

摘要:       虽然空格与空行在Java语言中没有多大实际的含义,但是一些有经验的程序开发人员却很喜欢使用它们。因为可以通过在合适的地方插入空格与空行,来提高应用...
关键词: 空格 nbsp 之间 空行 代码 变量 括号 空白行 一个 可读性

      虽然空格与空行在Java语言中没有多大实际的含义,但是一些有经验的程序开发人员却很喜欢使用它们。因为可以通过在合适的地方插入空格与空行,来提高应用程序源代码的可读性。不过需要注意的是,这个空格与空行是一把双刃剑。合理运用空行与空格可以增强程序代码的层次性与清晰性。相反,如果应用的地方不脆,则会起到相反的效果。那么这个空格与空行具体该如何应用才能够起到其应有的效果呢?且听笔者慢慢道来。     一、在逻辑上相关联的代码块之间合理的插入空行。     在一个代码文件中,根据其逻辑功能的不同,可以分为几个独立的部分。如果在这几个代码块之间,插入空行,则可以将它们彼此区分开来,更加容易阅读。如在同一个源文件中,可能同时同一了类与接口,此时在它们之间可以看情况插入两行空白行,以进行分离。通常情况下,对于同一源文件的两个代码片断之间,如上面提到的类与接口的定义,一般是插入两行空白行。     而在某些情况下,习惯只插入一行空白行即可。如在同一个源文件中定义的两个方法之间,习惯只插入一行空白行。再如在块注释与行注释之前,可以利用空白行与前面的代码分开。有些程序开发人员也喜欢在块注释与行注释之后也插入一行空白行,这也是可行的。另外,在方法内部的本地变量与第一个语句之间,也最行插入一行空白行,以提高代码的清晰性。如一下这段代码:     Stu(){     int i=1;     statements;     }     这一段代码中,先定义一个普通的整型变量,然后再在这个变量后面插入一行空行,跟后面的代码进行隔离。而且一般定义变量的时候,都是将变量的声明放在块的头部,即将所有的变量声明都放在同一个地方。此时在最后一个变量声明完毕后,插入一条空白的行。就可以将变量的声明与后续的语句隔离开来,可以明显的增强代码的层次性。有些程序人员可能喜欢在用到变量的时候再进行声明,此时如果在变量后面插入一个空行,那么它们在后续声明变量的时候,可以及时的找到声明变量的地方。即可以将所有变量的声明都放在一起。故笔者认为,在变量声明的后面插入一条空行,是用对地方了。当然,这里是在最后一个变量声明的后面插入一条空行,而不是每一个变量后面插入一个空白行。     在使用这个空白行来增强代码清晰性与可读性的时候,笔者认为主要要注意两个地方。首先是需要清楚在哪些地方需要插入空白行。这靠死记硬背是不行的。笔者的建议是,在刚开始的时候可以适当的记忆。然后主要还是要依靠在后续的编程中,逐渐养成这个观念与习惯,让这些规则深入程序人员的脑中。其次需要注意的是,插入空行的数量。一般情况下,会根据代码的不同插入一行或者两行空白行。这主要是看代码的用途。如在同一个源文件的两个代码片断之间或者在同一个源文件的类与接口之间最好插入的是两条空白的行。相反,在同一源文件中的两个方法之间、块注释行注释与代码之间、在方法内部的本地变量与第一个语句之间、在方法内部的逻辑片断之间,一般只插入一条空白行。如此的话,会让源代码看起来更加具有层次性,从而提高代码的可读性。     二、巧妙利用空格提高代码的可读性。     除了使用空行外,通过使用空格来提高代码的可读性与清晰性也是程序员常用的手段。跟空行一样,这个空格的使用也没有强制性的规定。主要都是出于增强代码的可读性与清晰性的角度出发的。为此,如果不正确使用空格,一般编译器也不会提示错误信息。只是代码的可读性就会大大的降低。所以这主要是程序开发人员的一个习惯问题。笔者认为,要做一个有限的程序开发人员,必须要养成这一个习惯。否则的话,很可能被其他项目团队成员所排斥与鄙视。那么在什么情况下该使用空格呢?具体来说,如果遇到如下情况就需要考虑在合适的地方插入空格。     1、空格一般用于关键字与括号之间。     在Java代码中,关键字与括号可以用的是最多的。为了提高代码的可读性,在它们之间插入空格是空格使用的最频繁的地方。这里需要注意,有时会括号还会跟其他内容成堆出现。如现在有一个带参数的方法,那么方法名与括号也会成对出现。此时在方法名与左括号之间一般不插入空格。如此的话,就可以清楚的区分方法与关键字。如while (true)语句,where是关键字,在与左括号之间就有一个空格以示区分。而在stu(num1)这个方法中,方法名字与左括号之间则没有采用空格。如此一看之下,就能够区分出那个是方法名字,那个是关键字。而不用再在脑袋中转个弯。总之,并不是在所有括号的前面都需要加入一个空格。一般情况下,只有在关键字与左括号之间才需要插入空格。而在其他地方,如方法名字与括号之间也不需要插入空格。故在空格使用的时候最容易犯的错误就是画蛇添足,在不需要的地方采用了空格。从而降低空格的作用。     2、在参数列表中的逗号后面插入空格。     有些方法可能会带入不只一个参数,此时不同的参数之间会利用逗号进行分割。按照笔者的习惯,光用逗号分割还不行。笔者还喜欢在逗号后面再加入一个空格来进行隔离。其实这并不是笔者的专利。很多程序开发人员都会这么做。如现在有一个方法,需要往这个方法中传入学生编号、科目编号、学生成绩等参数。此时这个参数列表就应该这么写。Stu(arg1, arg2, arg3)。注意参数名字与左括号之间是没有空格的。而每个参数之间,不仅用了逗号进行分割(这是语法上的要求),而且还在逗号后面插入了空格(这不是强制性的要求)。这会让参数之间的条理性更加的清晰。     同理其他的参数之间,也最好在法定的分割符号之外,再加入一个空格。如在for语句中也可以带多个参数或者表达式。如for(arg1; arg2)语句,此时除了需要使用分号来进行分割之外,还需要在分号后面插入一个空格,将它们进一步隔离开来。从而进一步提高代码的可读性。     3、四则运算的操作符与操作数之间应该插入空格。     在Java应用程序开发中,往往需要用到四则运算。虽然这个运算代码编写比较简单,但是为了提高代码的可读性,最好在四则运算的操作符号与操作数之间插入空格。如a = b + c这个简单的赋值语句中,a、b、c是运算的操作数,而+、=则是运算符号。在它们之间最好能够插入空格。不过这也有例外,如通常情况下在二进制运算与一元元算的时候,不需要插入空格。如i++,此时在操作数与运算符号之间就没有加入空格。     除了以上这些应该插入空格的地方外,在强制类型转换语句中的强制类型的右括号与表达式之间最好也应该利用逗号隔开。如(byte) num中,(byte)是强制类型转换语句,而num是转换对象,此时在它们之间(即右括号与转换对象之间)最好能够加入一个空格。     显然在什么地方插入空格,要比插入空行要复杂的多。此时如果单凭记忆,显然会有遗漏的地方。笔者认为,最好的方式就是程序员要在日常工作中有意识的去养成这个习惯。只有熟悉了这些规则,那么在编写源代码的时候,才会习惯性的加入空格。而不需要刻意去做。熟能生巧,在这里还是很管用的。
声明:文章版权归原作者所有 部分文章转自互联网 如有侵权请联系 [邮箱地址] 删除

路过

雷人

握手

鲜花

鸡蛋

最新评论

返回顶部