6.7Java中的三种注释.pdf

2.7 注释和Java文档的生成 2.7.1 单行注释 注释一行或一行的后面部分，采用 “//”标记。注释从 “//”开始，到该行尾 结束。 2.7.2 多行注释 以 /* 开始，以 */ 结束，注释范围可以跨跃多行。 2.7.3 文档注释 以 /** 开始，以 */ 结束，注释范围可以跨跃多行。 在用/**开头后，第一行，或者头几行是类、变量或方法的主要描述。其后， 可以包括一个或多个不同的@标记。每个@标记必须在一个新行的开头，或者跟随一 个星号(*)之后。同类型的多个标记应该组合在一起。例如： javadoc.exe就是用来将程序代码内嵌文档提解出来的工具。使用javadoc命 令将Java程序的源文件作为输入，输出几个包含该程序文档的HTML文件。每个类 的信息都在其自己的HTML文件中。同时，javadoc还输出一个索引和一个层次结 构树。 一个Java文档注释应该被放置于紧靠在它所要注释的程序元素之上例如，如 果该注释位于一个class语句之前，它应该描述出这个类的目的。除了描述文本外， 不同的条目可以被用来进一步说明这个程序元素。这些被称作 “标签”，它们前面 有一个@符号，后面跟着空格和描述性的语句或段落。使用文档注释的程序Demo代 码如下： /** *Description: 通过Person类来说明Java中的文档注释br *@author The East Winner *@version 1.00 */ public class Person{ private String name = Careers; private String sex = male; private int age = 30; /** *这是Person对象无参数的构造方法 */ public Person(){ } /** *这是Person类的有参构造方法 *@param name Person的名字 *@param sex Person的性别 *@param age Person的年龄 */ public Person(String name,String sex,int age){ this.name = name ; this.sex = sex; this.age = age; } /** *这是设置name的值的方法，将参数name的值赋给变量this.name *@param name Person的名字 */ public void setName(String name){ this.name = name; } /** *这是取得name的值的方法 *@返回 name的值 */ public String getName(){ return name; } /** *这是取得age的值的方法 *@返回 age的值 */ public int getAge(){ return age; } /** *这是设置sex的值的方法，将参数sex的值赋给变量this.sex *@param sex Person的性别 */ public void setSex(String sex){ this.sex = sex ; } /** *这是取得sex的值的方法 *@返回 sex的值 */ public String getSex(){ return sex; } /** *这是设置age的值的方法 *@param age Person的年龄 */ public void setAge(int age){ if(age0) this.age = 0; else this.age = age; } public void sho