零基础学Java第2版
上QQ阅读APP看书,第一时间看更新

4.1 编程风格

本章开始接触到编写Java程序代码,有一点必须强调,那就是编程风格的问题,虽然其不影响程序代码段的运行,但对于程序的可读性起着重要的作用。自己编出的程序要让别人看懂,首先在排版方面要非常注意,下面将探讨编程风格的问题。

其实每个人、每个软件开发公司的编程风格都不一样。一个人编写的程序代码,就应该能让别人看懂,甚至是过了很长时间,自己也要看得懂,否则这个程序就成了一个没法扩展的程序。编程风格是指编程时的格式,让程序看上去就很有层次感。

【实例4.1】下面通过一些例子,说明编程风格的重要性,先来看第一个例子。

01   public class math
02   {
03         public static void main(String[] args)
04         {
05             int x=12;
06             double y=12.3d;
07             void print()
08             {
09                 char a='a';
10                 System.out.println(a);
11             }
12             System.out.println(x+y);
13         }
14   }

【代码说明】上面程序段的整个排版看起来是否很舒服,并且层次感很强?是否一眼看上去就知道整个程序架构?这里的关键在于缩排,缩排也称为跳格。

上一个程序段采用的跳格形式:“public class math”是顶格的,接着主运行程序前跳4个空格,在主运行程序内的运行代码段一律跳8个空格,而在主运行程序方法内的代码前,再跳4个空格。这样整个程序的所属关系就很明显了。主运行程序从属于“math”类,其余的都属于主运行程序,而在主运行程序方法内的代码段又属于此方法。规律就是空格多的代码从属于空格少的代码。

【运行效果】这段代码无法正常运行,这只是给读者讲解结构和排版的形式。

【实例4.2】除了空格外,空行也是必要的。为什么要使用空行呢?先看下列程序代码,再来仔细分析。

01   public class math
02   {
03        public static void main(String[] args)
04        {
05             int x=12;
06             int y=23;
07             void print()
08             {
09                  ...
10             }
11
12             void view()
13             {
14                  ...
15             }
16        }
17   }

【代码说明】在“print”方法与“view”方法之间有个空行(第11行),使用空行区分不同功能的模块。“print”方法所完成的功能与“view”所完成的功能不一样,所以使用空行将它们分开,这样更增加了程序的可读性。

【运行效果】这段代码无法正常运行,这只是给读者讲解结构和排版的形式。

另外,需要注意的是方法或属性的命名。这些名字应该有含义,最好有规律。不要只使用“a”、“b”这种通用变量,适当可以根据变量或函数的功能为其命名。上面的“print”,其他程序员一看就知道这个方法,是有关打印或输出的函数。再如变量名“name”,一看就知道是有关名字的变量。所以,一定要命名的有意义,否则程序的可读性不强。

还有一点是有关注释的。在每个方法的方法名旁边,应该添加一些注释,同时在一段程序完成之后,也要对程序的功能及如何操作做简单的描述。

只要做到以上几点,这个程序就是易读的。即使自己在很长时间后,再来读程序也会一目了然。