2.1　程序注释

在程序中，由于其基本组成都是代码，所以考虑到程序的可维护性的特点，在编写代码的时候都要在每段代码上增加若干说明文字，即注释。注释本身不需要被编译器编译。Java一共分为3种形式。

//注释：单行注释。

/* ...*/：多行注释。

/** ...*/：文档注释。

提示：关于几种注释的选择。

一般而言，在开发中往往会接触一些开发工具，如果使用Eclipse或IDEA这样的开发工具，本书强烈读者使用单行注释，这样即使格式化多行代码时也不会造成代码的混乱。而对于文档注释，也往往会结合开发工具编写。为方便读者理解相关定义的含义，本书中将针对一些重点说明的操作给出文档注释，而考虑到篇幅问题，重复的注释将不再出现。

范例：定义单行注释

本程序的功能是在屏幕上进行信息输出，在注释信息追加后就可以明确通过注释获取代码的作用，使得代码的可读性与维护性大大加强。

范例：定义多行注释

多行注释利用“/* … */”进行定义，而后每行注释中使用“*”作为标记。

文档注释是以单斜杠加两个星形标记（/**）开头，并以一个星形标记加单斜杠（*/）结束。用这种方法注释的内容会被解释成程序的正式文档，并能包含进如javadoc之类的工具生成的文档，用以说明该程序的层次结构及其方法。

范例：使用文档注释

在文档注释中提供了许多类似于“@author”这样的标记，例如，参数类型、返回值、方法说明等。而对于初学者而言，重点掌握单行注释和多行注释即可。

提示：文档注释在开发中使用较多。

在进行软件开发的过程中，开发的技术文档是每一位开发人员都必须配备的重要工具之一，对于每一个操作的功能解释都会在文档中进行详细的描述，所以本书强烈建议读者在开发代码的过程中要养成编写文档注释的良好编程习惯，在以后有了开发工具的支持环境下，文档注释可以方便地生成。