杭州java咖啡_Java咖啡馆(4)——品味第一杯咖啡

品过第一杯咖啡后，你肯定急于了解Hello World!程序是如何编写并工作的，以及如何编写其他Java程序。在这章中，让我们回味第一杯咖啡，并且深入分析Java程序的结构。

一、注释与文档

之所以把Java注释和文档功能放在最前面介绍，是因为Java程序的理念使然——所谓兵马未动粮草先行。

几乎所有编程语言都提供在源代码中添加注释的功能，开发者通过注释给自己或代码的阅读者进行备忘或提示，好比读书时在书上的空白处写笔记，或在屋子里使用N次贴。Java语言一个优秀思想便是——编写源代码并非唯一重要的工作，给源代码加上详细的注释同样重要。道理很简单，源代码和Java的字节码不同，字节码是给电脑看的，而源代码是给人阅读的，没有好的文档与注释，阅读源代码必须猜测源代码作者的意图，势必枯燥而且效率低下。

Java中的注释一共有两种，我们的Hello World!程序麻雀虽小但是五脏俱全，全部都用到了。下面是Hello World!程序的源代码:

/*

* Created on 2004-6-4

*

* TODO To change the template for this generated file go to

* Window - Preferences - Java - Code Style - Code Templates

*/

/**

* @author gary chan

*

* TODO To change the template for this generated type comment go to

* Window - Preferences - Java - Code Style - Code Templates

*/

public class HelloWorldApp {

public static void main(String[] args) {

// 打印Hello World!字样

System.out.println("Hello World!");

}

}

第一种注释是从C语言继承过来的风格，注释从/*开始，到*/结束，它们必须成对使用，之间可以换行。Hello World!程序开头部分就是这种风格的注释，记载着这个源程序的创始时间和一些提示。许多程序员为了美观，喜欢在多行注释前加入一个*符号，从而就形成了上面的格局。当然，这个注释的内容是Eclipse自动生成的，你可以通过修改Eclipse的代码模板来修改自动生成的内容。

第二种注释是从C++语言继承过来的单行注释风格，注释从//开始，一直到这行结束。这种风格的注释非常容易使用，你不必低头在键盘上连续寻找/和*键，只需要连续按下/键两次。同时，不需要像C语言风格注释那样特意使注释符号配对。Hello World!程序中“// 打印Hello World!字样”就是这种风格的注释。

如果你的洞察力敏锐，你会发现Hello World!程序中还有一处用/**和*/包裹起来的的代码并不属于以上任何一种注释。没错，这是Java文档(Java documentation)。文档与注释不同，注释一般比较随意，反映的是局部语句的功能或声明，而文档是与代码的结构相关的，好比是代码的摘要，给人一个结构化的总体观念。特别地，Java文档所注释的，是紧随其后的类、变量或方法。

我们还是结合Eclipse来说明Java文档的应用。首先在Eclipse中打开Hello World!程序。试试看把鼠标移动到HelloWorldApp字符上面去，是不是显示了如图1所示的效果(图1  Eclipse自动显示Java文档的功能)？